Perfion Knowledge Base

https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals
Admin
The Perfion Knowledge Base provides guides and manuals for effectively working with the Perfion...
Tokens:332,394
Snippets:2,425
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Sample XML Result from Setup Method

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332546/Setup

An example XML response showing the configuration settings returned by the E-commerce API after a successful call to the 'Setup' method, reflecting the applied parameters.

```XML
<Response>
 	 <Result>
 		 <Settings>
 			 <Setting>
 				 <Name>ResourceMode</Name>
 				 <Value>ResourcesInFiles</Value>
 			 </Setting>
 			 <Setting>
 				 <Name>LogMode</Name>
 				 <Value>EnableLogging</Value>
 			 </Setting>
 			 <Setting>
 				 <Name>WorkFolder</Name>
 				 <Value>c:\temp\ECommerceAPI_Workfolder</Value>
 			 </Setting>
 			 <Setting>
 				 <Name>WriteEngineFiles</Name>
 				 <Value>true</Value>
 			 </Setting>
 		 </Settings>
 	 </Result>
</Response>
```

--------------------------------

### Sample XML Request for Setup Method

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332546/Setup

An example XML request demonstrating how to invoke the 'Setup' method with various parameters to configure the E-commerce API's operational settings, including resource mode, logging, work folder, and engine file writing.

```XML
<Execute method="Setup">
 	 <Parameter id="ResourceMode" value="ResourcesInFiles" />
 	 <Parameter id="LogMode" value="EnableLogging" />
 	 <Parameter id="WorkFolder" value="c:\temp\ECommerceAPI_Workfolder" />
 	 <Parameter id="WriteEngineFiles" value="true" />
</Execute>
```

--------------------------------

### Configure PerfionAPIService Database Connection String

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Steps to configure the database connection for PerfionAPIService by editing the Web.config file. This involves creating a copy of the example file, opening it, and updating the 'PerfionConn' connection string with the correct database credentials and settings.

```XML
1. Start Windows Explorer and go to C:\inetpub\Perfion\PerfionAPIService
2. Create a copy - in the same folder - of Web.config.example and name the copy Web.config
3. Open Web.config with a text editor
4. Edit PerfionConn to match your Perfion database setup. Example:

<connectionStrings>
 <add name="PerfionConn" connectionString="Data Source=(local);User ID=dbuser;Password=dbuser-password;Initial Catalog=perfion;PerfionUserID=admin;PerfionPassword=admin-password;PerfionLanguage=" />
</connectionStrings>

5. Save and close the file
```

--------------------------------

### Azure App Service (Web App) Creation Parameters

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Defines the essential parameters required for setting up an Azure App Service to host the Perfion Web Client. These parameters guide the configuration of the web app within the Azure portal.

```APIDOC
App Service (Web App) Configuration:
  Subscription: Choose the subscription that will be used for billing
  Resource Group: Select the resource group where the App Service will be stored
  App Name: Enter a name for the website, which will also serve as the URL to access it
  Publish: "Code" as the deployment method
  Runtime Stack: "ASP.NET v4.7" for the runtime
  Operating System: "Windows"
  Region: Pick the region where the web app should be hosted. Ensure it aligns with the regions selected for the backend APIs to minimize latency
  App Service Plan: Choose the appropriate App Service Plan under which the web app will run
```

--------------------------------

### Web Service Response: Test (Setup) Mode Data Structure

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244337114/Remote+Query+Setup+for+Web+Service

Illustrates the data structure returned by the web service when operating in 'Test (setup)' mode, including Key, Name, PriceInEUR, and Description fields with example product data. This mode provides full data for testing purposes.

```APIDOC
|  |  |  |  |
| --- | --- | --- | --- |
| **Key** | **Name** | **PriceInEUR** | **Description** |
| **2** | Product 2 | 15.8 | Product 2 description |
| **4** | Product 4 | 45.5 | Product 4 description |
| **6** | Product 6 | 6.4 | Product 6 description |
```

--------------------------------

### Install Perfion Application Server as a Windows Service

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244325971

This command installs the Perfion Application Server executable as a Windows service using InstallUtil.exe. It should be executed from an administrator command prompt within the application's installation directory. The service name and display name are determined by the associated InstallUtil.exe.config file.

```Command Line
InstallUtil.exe "Perfion.ApplicationServer.Service.exe"
```

--------------------------------

### Initial Perfion Supplier Portal config.json Structure

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243497822/Supplier+Portal+-+Installation

This snippet shows the default structure of the config.json file found in the Perfion Supplier Portal installation, defining relative URLs for various Perfion services. This file needs to be copied from config.json.example and then updated.

```JSON
{
 "ServicesBaseUrl" : "/PerfionWebApi/",
 "ImageServerUrl": "/Perfion/Image.aspx",
 "FileServerUrl": "/Perfion/File.aspx",
 "ReportServerUrl": "/Perfion/Report.ashx"
}
```

--------------------------------

### Specific Examples of Action, From, and RefAction Item Paths

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244333295

Provides concrete examples of path construction for Action, From, and RefAction items based on a sample setup. These examples demonstrate the application of normal and virtual path rules, including how catalog items are represented as virtual paths.

```Path Format
^CatalogItem
```

```Path Format
^CatalogItem|VirtualItem
```

```Path Format
CatalogItem|VirtualItem|NormalItem
```

```Path Format
^VirtualItem2
```

```Path Format
VirtualItem2|NormalItem2
```

```Path Format
^VirtaulFromItem1
```

```Path Format
VirtaulFromItem1|NormalFromItem1
```

```Path Format
^VirtaulFromItem2
```

```Path Format
VirtaulFromItem2|NormalFromItem2
```

```Path Format
VirtualItem2|NormalItem2
```

```Path Format
^VirtualItem2
```

--------------------------------

### Create New IIS Website for Perfion Web Client

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Instructions for setting up a new website in IIS Manager for the Perfion Web Client. This involves specifying the site name, physical path, and network binding settings (IP address, port, hostname).

```IIS
1. Open IIS Manager
2. Right-click on Sites in the Connections panel and select Add Website
3. Make the following settings:
   a. Set the Site name to PerfionWebClient
   b. Set the Physical path to the directory where the folder PerfionWebClient is located, for example: C:\inetpub\Perfion\PerfionWebClient
   c. Set IP address, Port, and Hostname to the relevant local settings
4. Click OK to create the website
```

--------------------------------

### Install IIS and ASP.NET 4.x Features via PowerShell

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244330766

Commands to install and configure necessary Microsoft .NET Framework 4.8 and Internet Information Services (IIS) features, including ASP.NET 4.x, required for the Perfion API Service. These commands should be run in Windows PowerShell.

```PowerShell
Install-WindowsFeature NET-Framework-45-Features -IncludeAllSubFeature
```

```PowerShell
Install-WindowsFeature Web-Server,Web-WebServer,Web-Common-Http,Web-Default-Doc,Web-Dir-Browsing,Web-Http-Errors,Web-Static-Content,Web-Http-Redirect,Web-Health,Web-Http-Logging,Web-Custom-Logging,Web-Request-Monitor,Web-Http-Tracing,Web-Performance,Web-Stat-Compression,Web-Security,Web-Filtering,Web-Basic-Auth,Web-App-Dev,Web-Net-Ext45,Web-Asp-Net45,Web-ISAPI-Ext,Web-ISAPI-Filter,Web-Mgmt-Tools,Web-Mgmt-Console
```

--------------------------------

### Register .NET Framework with IIS

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244330766/Installation+guide

This command-line utility registers the .NET Framework with Internet Information Services (IIS). It is essential to run this if IIS was installed after the .NET Framework to ensure proper configuration and functionality. The utility is typically located in the .NET Framework installation directory, e.g., 'c:\Windows\[Microsoft.NET]\Framework\[vX.X.XXX]\'.

```cmd
aspnet_regiis.exe -I
```

--------------------------------

### Example Perfion Data Query for Release2ERP Integration

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244342290/Release2ERP+for+AX+4

This XML snippet demonstrates a sample Perfion API query used within the Release2ERP integration. It specifies the features (fields) to select, the data source ('Product'), and filtering clauses, including a dynamic placeholder ('%d') for the latest import date to retrieve recently modified records.

```XML
<Query>
      <Select languages='EN, DE' view='Normal'>
            <Feature id='ItemNumber' />
            <Feature id='ShortText' />
            <Feature id='Description' />
            <Feature id='Image' />
      </Select>
      <From id ='Product'/>
      <Where>
            <Clause id='brand' operator='=' value="Normal" />
            <Clause id='ModifiedDate' operator='>' value="%d" />
      </Where>
</Query>
```

--------------------------------

### EC API GetProducts Request Example

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332546/Setup

This XML snippet demonstrates a basic `GetProducts` request to the EC API. It specifies a 'Channel' parameter with the value 'My Channel' to filter the product retrieval. This type of request is often logged by EC when `LogMode` is enabled, providing insight into the API's internal processing.

```XML
<Execute method="GetProducts">
  <Parameter id="Channel" value="My Channel" />
</Execute>
```

--------------------------------

### Migrate Multi-Value SQL Parameter to Perfion Setup XML using @REPLACE

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244337055/Remote+Query+Setup+for+Database

This example illustrates how to relocate a multi-value SQL parameter from a direct query definition to Perfion's Setup XML using the special `@REPLACE` parameter. Since Setup XML only supports single values directly, `@REPLACE` enables specifying exact multi-values without preprocessing, ensuring proper handling of lists.

```SQL
SELECT * FROM MyData WHERE ID IN (#@MyParameter:1,2,3#)
```

```SQL
SELECT * FROM MyData WHERE ID IN (#@REPLACE_MyParameter#)
```

```XML
<Test>
  <Parameter id='Replace_MyParameter'>1,2,3</Parameter>
</Test>
<Default>
  <Parameter id=' Replace_MyParameter’>1,2,3</Parameter>
</Default>
```

--------------------------------

### Launch Perfion with Specific Client Configuration

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244323725/Windows+Administration+Guide

This command line example demonstrates how to launch the Perfion application using a specific client configuration file. The `-ClientConfig` argument specifies the path to an XML file that defines the connection profile for the Perfion database. This method is useful for automating Perfion startup with predefined settings or for managing multiple connection profiles.

```Windows Command Line
"C:\Program Files (x86)\Perfion\Perfion for Dynamics\bin\Perfion.exe" -ClientConfig="C:\Program Files\Perfion\ConfigFiles\PerfionDemo.xml"
```

--------------------------------

### Install Required Windows Features for Perfion API Service

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244330766/Installation+guide

These PowerShell commands install the necessary .NET Framework 4.8 features and Internet Information Services (IIS) components required for the Perfion API Service to function correctly. They should be executed in an elevated Windows PowerShell session.

```PowerShell
Install-WindowsFeature NET-Framework-45-Features -IncludeAllSubFeature
```

```PowerShell
Install-WindowsFeature Web-Server,Web-WebServer,Web-Common-Http,Web-Default-Doc,Web-Dir-Browsing,Web-Http-Errors,Web-Static-Content,Web-Http-Redirect,Web-Health,Web-Http-Logging,Web-Custom-Logging,Web-Request-Monitor,Web-Http-Tracing,Web-Performance,Web-Stat-Compression,Web-Security,Web-Filtering,Web-Basic-Auth,Web-App-Dev,Web-Net-Ext45,Web-Asp-Net45,Web-ISAPI-Ext,Web-ISAPI-Filter,Web-Mgmt-Tools,Web-Mgmt-Console
```

--------------------------------

### Setup Method API Parameters

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332546/Setup

Defines the configurable parameters for the 'Setup' method of the E-commerce API, detailing their purpose, whether they are mandatory, and their default behaviors.

```APIDOC
Method: Setup
Parameters:
  - Name: ResourceMode
    Mandatory: No
    Description: The resource mode you want EC to run in. See available options in Section ResourceMode. Default value is current ResourceMode.
  - Name: LogMode
    Mandatory: No
    Description: The log mode you want EC to run in see Section LogMode. Default value is current LogMode.
  - Name: WorkFolder
    Mandatory: No
    Description: The root-folder in which either Engine or Log-files are stored in. Default value is current WorkFolder.
  - Name: WriteEngineFiles
    Mandatory: No
    Description: When true, the engine files (xml- and xsl-files) will be written to disk. Note: This will overwrite any same-named files already written. Default value is false.
```

--------------------------------

### Launch Perfion Client with Custom Configuration File

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244323725

This command line example demonstrates how to start the Perfion client application and specify a custom client configuration file using the `-ClientConfig` argument. This allows the application to connect to a Perfion database using a predefined connection profile, overriding the default configuration file location.

```Windows Command Line
"C:\Program Files (x86)\Perfion\Perfion for Dynamics\bin\Perfion.exe" -ClientConfig="C:\Program Files\Perfion\ConfigFiles\PerfionDemo.xml"
```

--------------------------------

### Sample InstallUtil.exe.config for Service Configuration

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244325971

This XML configuration file is used by InstallUtil.exe to define service properties such as ServiceName, DisplayName, and Description for a Windows service. It ensures unique identification and display in the Services-Window, especially when running multiple instances.

```XML
<configuration>
	<startup useLegacyV2RuntimeActivationPolicy="true">
		<supportedRuntime version="v4.0.30319"/>
	</startup>
	<appSettings>
		<add key="ServiceName" value="My.Application.Server.Production"/>
		<add key="DisplayName" value="My Production Application Server"/>
		<add key="Description" value="My Perfion Application Server for Production"/>
	</appSettings>
</configuration>
```

--------------------------------

### Add PerfionAPIService Application to IIS Site

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Steps to add the PerfionAPIService as an application under the existing PerfionWebClient IIS site. This involves specifying the physical path to the PerfionAPIService folder.

```IIS
1. Expand Sites, right-click PerfionWebClient, and choose to Add Application
2. Set the Physical path to the directory where the folder PerfionAPIService is located, for example: C:\inetpub\Perfion\PerfionAPIService
3. Click OK
```

--------------------------------

### Perfion.CreateConfiguration Method Example

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244329460/Method+Perfion

An example demonstrating the usage of the Perfion.CreateConfiguration method. It shows how to configure features for 'Product' and 'Category', exclude 'Section' and 'Campaign', set a 50% threshold, and specify view flags for 'allViews' and 'depViews'.

```C#
Perfion.CreateConfiguration(
"Product",
"Category",
createAllThreshold: 50,
allViews: 512,
depViews: 1024,
excludeFeatures: "Section,Campaign",
);
```

--------------------------------

### Configure .NET Framework for IIS After Installation

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244330766

This snippet provides the command to correctly configure the .NET Framework for Internet Information Services (IIS) if IIS was installed on the machine after the .NET Framework. Running this command ensures that IIS is properly configured to use the .NET Framework, resolving potential functionality issues. The 'aspnet_regiis.exe' utility is typically found in 'c:\Windows\[Microsoft.NET]\Framework\[vX.X.XXX]\'.

```Command Prompt
aspnet_regiis.exe -I
```

--------------------------------

### Example Hierarchical Item Path Constructions

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244333295/Import+Export+Actions

Illustrates concrete examples of path constructions for various Action, From, and RefAction items based on a sample setup, demonstrating the application of normal, virtual, and catalog item rules.

```APIDOC
Action Items:
  CatalogItem:
    Type: Catalog
    Path: ^CatalogItem
    Description: Catalog is treated as if it is a virtual item.
  VirtualItem:
    Type: Virtual
    Path: ^CatalogItem|VirtualItem
    Description: The path references virtual item, therefore there is a virtual indicator as prefix to the path.
  NormalItem:
    Type: Normal
    Path: CatalogItem|VirtualItem|NormalItem
    Description: Normal item does not have a prefix.
  VirtualItem2:
    Type: Virtual
    Path: ^VirtualItem2
  NormalItem2:
    Type: Normal
    Path: VirtualItem2|NormalItem2
From Items:
  VirtualFromItem1:
    Type: Virtual
    Path: ^VirtaulFromItem1
    Description: From item paths follow the same rules as action items.
  NormalFromItem1:
    Type: Normal
    Path: VirtaulFromItem1|NormalFromItem1
  VirtualFromItem2:
    Type: Virtual
    Path: ^VirtaulFromItem2
  NormalFromItem2:
    Type: Normal
    Path: VirtaulFromItem2|NormalFromItem2
RefAction Items:
  NormalItem2:
    Type: Normal
    Path: VirtualItem2|NormalItem2
    Description: RefAction refers to actual Action items and have the same paths.
  VirtualItem2:
    Type: Virtual
    Path: ^VirtualItem2
```

--------------------------------

### Initial Perfion Supplier Portal config.json Structure

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243497822

This snippet displays the default content of the `config.json` file as provided with the Perfion Supplier Portal installation. It illustrates the initial relative paths used for various Perfion services before specific web client integration.

```JSON
{
 "ServicesBaseUrl" : "/PerfionWebApi/",
 "ImageServerUrl": "/Perfion/Image.aspx",
 "FileServerUrl": "/Perfion/File.aspx",
 "ReportServerUrl": "/Perfion/Report.ashx"
}
```

--------------------------------

### Create SQL Login for Perfion Database

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466323/Database+-+Installation+guide

This SQL script creates a new login and a corresponding user in the `Master` database. This login is intended for the Perfion database, setting up the username and requiring a strong password.

```SQL
USE [Master]
CREATE LOGIN [perfion-dbuser] WITH PASSWORD = '<strong password>'
CREATE USER [perfion-dbuser] FROM LOGIN [perfion-dbuser]
```

--------------------------------

### Release2ERP Integration Configuration Header Fields

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244342290/Release2ERP+for+AX+4

This section documents the key configuration parameters available on the 'Overview' tab for setting up a Release2ERP integration in Perfion. It details fields such as the unique identifier, description, selected data connection, XPath root for data, and options for handling multiple record updates during import.

```APIDOC
Integration:
  Description: Unique identifier for this integration.
Description:
  Description: A short description of the integration.
Connection:
  Description: Select from the list of connections you have created.
XPath root:
  Description: Root node containing data from Perfion. Defaults to //Data/Product. Change this value if it does not reflect data in your Perfion database.
Update multiple records:
  Description: Allow updating multiple records when finding existing records matching criteria.
  Options:
    Yes: Update possible duplicates.
    No: Skip updates.
    Error: Stop the import when finding multiple records.
Latest import:
  Description: Latest execution date and time. Not editable.
```

--------------------------------

### Recommended API Deployment Method for Azure App Service

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Identifies 'Zip Deploy' as the most efficient and recommended method for integrating API data into an Azure App Service. This method streamlines the deployment process for Perfion APIs.

```APIDOC
API Deployment Method:
  Method: Zip Deploy
  Recommendation: Most efficient and recommended approach for integrating API data.
  Reference: [Deploy Files - Azure App Service](https://docs.microsoft.com/en-us/azure/app-service/deploy-zip)
```

--------------------------------

### Add PerfionClientAPI Application to IIS Site

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Steps to add the PerfionClientAPI as an application under the existing PerfionWebClient IIS site. This involves specifying the physical path to the PerfionClientAPI folder.

```IIS
1. Expand Sites, right-click PerfionWebClient, and select Add Application
2. Set the Physical path to the directory where the folder PerfionClientAPI is located, for example: C:\inetpub\Perfion\PerfionClientAPI
3. Click OK
```

--------------------------------

### Configure PerfionAPIService Database Connection String

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669/Web+Client+-+Installation+Guide

This snippet demonstrates how to configure the database connection string for the PerfionAPIService within the Web.config file. It specifies parameters such as data source, user ID, password, initial catalog, and Perfion-specific user credentials and language settings.

```XML
<connectionStrings>
 <add name="PerfionConn" connectionString="Data Source=(local);User ID=dbuser;Password=dbuser-password;Initial Catalog=perfion;PerfionUserID=admin;PerfionPassword=admin-password;PerfionLanguage=" />
</connectionStrings>
```

--------------------------------

### Configure Perfion Desktop Shortcut Target

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466488/Windows+Client+-+Installation+Guide

This snippet demonstrates how to modify the target path of the Perfion desktop shortcut to include a '-ClientConfig' argument. This argument points to an XML file that will store the client's database connection settings, allowing for centralized or custom configurations. The examples show both a local path and a network URN path.

```Windows Command Prompt
-ClientConfig="C:\Perfion\ConfigFiles\ ClientConfig.xml"
```

```Windows Command Prompt
"\\192.168.11.31\PerfionShare\Perfion for Dynamics\bin\Perfion.exe" -ClientConfig = "\\192.168.11.31\PerfionShare\Connections\Perfion\_Live.xml"
```

--------------------------------

### Create and Configure Cache Folder for Perfion Web Client

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Instructions for creating a 'Cache' folder within the Perfion Web Client directory and subsequently granting full control permissions to the designated AppPool Group User (PerfionWebClient) for proper operation.

```Windows
1. Go to folder C:\inetpub\PerfionWebClient\Perfion
2. Create a folder called Cache
3. Right-click on Cache folder, and choose Properties
4. Add the AppPool Group User PerfionWebClient and grant full control over the folder
```

--------------------------------

### Example EC GetProducts Response

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244331086/Ecommerce+API

Illustrates a sample XML response from the ECommerce (EC) API for a 'GetProducts' request. It shows the structure for a channel, total product count, and details for individual products including fields (Title, Description, Item No) and image information (URL, GUID, file name).

```XML
<Response>
  <Result>
    <Channel name="My Channel">
      <TotalCount>122</TotalCount>
      <Products>
        ...
        <Product id="626" ecommerceproduct="980ST">
          <Fields>
            <Field name="Title" culture="en-US">Vacuum Jug EM77  Olive</Field>
            <Field name="Description" culture="en-US">The vacuum jug with the unique rocker stopper was created by Erik Magnussen and is one of Stelton's best-selling designs ever. Besides the rocker stopper it has a screw cap for transportation of liquids.
This is the ABS plastics version but it is also available in a stainless steel and a soft coated version. The recent years it has become quite a fashion icon setting the trend every spring and autumn with new seasonal colours.</Field>
            <Field name="Item No">980ST</Field>
          </Fields>
          <Images>
            <Image name="Main Image" perfionname="Image">
              <Guid>69ad0d4a-f793-4499-82d8-44d06406c787</Guid>
              <OriginalFileName>980ST_(1000x1000).png</OriginalFileName>
              <Url>http://(yourimageserverhere)?id=69ad0d4a-f793-4499-82d8-44d06406c787&amp;format=jpg&amp;size=1024x1024</Url>
              <ConstructedFileName>69ad0d4a-f793-4499-82d8-44d06406c787.png</ConstructedFileName>
            </Image>
          </Images>
        </Product>
        ...
      </Products>
    </Channel>
  </Result>
</Response>
```

--------------------------------

### Setup XML Parameter Definitions

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244336983/Remote+Query

This section provides a detailed reference for parameters used in Setup XML, outlining their function, where they apply (Test or Default mode), and how Perfion interprets their values and behavior.

```APIDOC
Parameter: Group
  Location: Test, Default
  Description: Headers only breaker parameter and it can also be used to select data by some grouping category. It is used only with Web Service remotes.
    Values: "All" and "None" are reserved by Perfion, but custom values can also be used if Web Service supports it. "None" value means that only headers are requested from remote data source and "All" means that it must return all data.
    Default: If parameter is not defined, Perfion will use "All" as default value.

Parameter: Key
  Location: Test
  Description: Key values for key feature.
  Location: Default
  Description: Key values for key feature. Perfion will overwrite key values, which will be taken from Perfion depending on the context where from the remote feature is used. For example, if remote feature is shown in the grid, then all key feature values shown in the grid will be used as key values.

Parameter: Field
  Location: Test
  Description: Fields defines remote data columns needed for retrieval. These parameters are used only with Web Service remotes and are optional.
    Default: By default, if they are not defined, then all available remote data should be returned. If fields are defined, then Web Service is supposed to return only remote data columns specified by field parameter values.
  Location: Default
  Description: Field parameters will be modified by Perfion. It will add required field parameters based on the context if they are not manually defined by user.

Parameter: Variant
  Location: Test, Default
  Description: Variant parameter values will be used based on what is the type of the remote, e.g. Single or Cluster type.
    Cluster type: For Cluster type remote Variant parameter will work like custom string type parameters, but it will use multiple values instead of a single value.
    Single type: For Single type remote Variant parameter will not be used by Perfion for special data handling. However, Variant parameter will work like a custom multi-value parameters and can still be used. However, we do not recommend using it in this way and instead use other type of parameters.

Parameter: Languages
  Location: Test
  Description: Allows to specify language codes. The primary intention is to allow creating remote queries, which can deliver data for localizable remote feature. Localizable remote features will have multiple data columns instead of one, e.g. one data column for each language. Languages parameter is mandatory if remote is specified as localizable (localizable attribute is set to “true” in Setup XML).
  Location: Default
  Description: As above, but here Perfion will overwrite all languages based on the context, where data is used from. If remote feature is used in the grid, then it will overwrite the languages parameter using default user language. If remote feature is used from the Item Editor, then Perfion may use all languages defined for the user.
```

--------------------------------

### Updated Perfion Supplier Portal config.json for Web Client Connection

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243497822

This snippet shows the necessary modifications to the `config.json` file to establish a connection between the Perfion Supplier Portal and the Perfion Web Client. It updates the service URLs from relative to absolute paths, requiring replacement of `http://localhost:8031` with the actual base URL of your Perfion Web Client installation.

```JSON
{
 "ServicesBaseUrl" : "http://localhost:8031/PerfionClientApi/",
 "ImageServerUrl": "http://localhost:8031/PerfionAPIService/Perfion/Image.aspx",
 "FileServerUrl": "http://localhost:8031/PerfionAPIService/Perfion/File.aspx",
 "ReportServerUrl": "http://localhost:8031/PerfionAPIService/Perfion/Report.ashx"
}
```

--------------------------------

### Configure Windows Host File for Web Service Access

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244339718/Perfion+Connector+App+Setup

This snippet shows the entry to be added to the Windows host file. This modification allows the system to resolve the 'perfionremotecontroller' hostname to the local machine's IP address, enabling direct access to the web service from the web browser and the Perfion Connector App.

```Host File Entry
127.0.0.1 perfionremotecontroller
```

--------------------------------

### Relocate Key and Variant Parameters from SQL to Setup XML

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244337055/Remote+Query+Setup+for+Database

Shows how to move multiple key and variant values from direct SQL query parameters (e.g., #@ID:1,2,3#, #@VARIANT:EUR,USD#) into structured XML elements within the Setup XML. This allows for defining multiple keys and variants, improving flexibility and readability.

```SQL
SELECT * FROM MyData WHERE ID IN (#@ID:1,2,3#) AND Currency IN (#@VARIANT:EUR,USD#)
```

```SQL
SELECT * FROM MyData WHERE ID IN (#@KEYFEATURE#) AND Currency IN (#@VARIANT#)
```

```XML
<RemoteQuerySetup name='QueryName' keyFeature='0' type='Single'>  <Test>  <Key>1</Key>  <Key>2</Key>  <Key>3</Key>  <Variant>EUR</Variant>  <Variant>USD</Variant>  </Test>  <Default>  <Variant>EUR</Variant>  <Variant>USD</Variant>  </Default>  </RemoteQuerySetup>
```

--------------------------------

### Perfion Web Client Configuration Parameters

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669/Web+Client+-+Installation+Guide

Defines the various configuration parameters for setting up the Perfion Web Client. These parameters control network settings (HTTPS, port, hostname), security (certificate, secure API), database connection details (SQL Server, database name, username, password), and Perfion user credentials.

```APIDOC
Installation Settings:
  HTTPS: Enable or disable HTTPS
  HTTP(S) Port: The port you want the application to run on
  Certificate: Certificate for HTTPS
  Hostname: Hostname you want the application to run on. Leave empty for localhost
  Secure API: Enable or disable secure API

  SQL Server: SQL server name (leave empty to use local data source)
  Database name: Name of Perfion database (selectable from a list of databases in the connection by clicking the three-dot button and opening the dropdown menu)
  Username: Username for Perfion database connection
  Password: Password for Perfion database connection

  Perfion User: Admin user for Perfion
  Perfion Password: Password for user
```

--------------------------------

### Install Perfion Scheduler as Windows Service

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244325717

This command installs the Perfion Scheduler executable as a Windows Service using the .NET Framework's InstallUtil utility. It must be executed from an administrator command prompt within the scheduler's installation directory to register the service with the operating system.

```Windows Batch
InstallUtil.exe "Perfion.Scheduler.Service.exe"
```

--------------------------------

### Perfion Web Client config.json Base Configuration

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669/Web+Client+-+Installation+Guide

Illustrates the initial structure of the `config.json` file used by the Perfion Web Client, defining URLs for various services like image, file, and report servers. This file is crucial for the web client's operation.

```JSON
{
 "ServicesBaseUrl" : "/PerfionClientApi/",
 "ImageServerUrl": "/PerfionAPIService/Perfion/Image.aspx",
 "FileServerUrl": "/PerfionAPIService/Perfion/File.aspx",
 "ReportServerUrl": "/PerfionAPIService/Perfion/Report.ashx"
 "customerDefinedLogo": ""
}
```

--------------------------------

### Perfion Remote Query XML Configuration

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244337391/Remotes+for+D365+Business+Central+Cloud

XML structure for defining a Perfion remote query. This example demonstrates how to set up a single-type query with a specific key feature and test key, useful for selecting a specific product based on its item number from Business Central.

```XML
<RemoteQuerySetup name='QueryName' keyFeature='2' type='Single' localizable='false'>
 <Test>
 <!-- Group parameter -->
 <Group>All</Group>
 <!-- Key parameters -->
 <Key>1896-S</Key>
 </Test>
 <Default>
 </Default>
</RemoteQuerySetup>
```

--------------------------------

### Configure Perfion Client API Database Connection (web.config)

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669/Web+Client+-+Installation+Guide

This snippet demonstrates how to configure the database connection string for the Perfion Client API in its `Web.config` file. It specifies the data source, user credentials, initial catalog, and Perfion-specific user/password/language settings required for the application to connect to the Perfion database.

```XML
<connectionStrings>
 <add name="PerfionConn" connectionString="Data Source=(local);User ID=dbuser;Password=dbuser-password;Initial Catalog=perfion;PerfionUserID=admin;PerfionPassword=admin-password;PerfionLanguage=" />
</connectionStrings>
```

--------------------------------

### Configure Perfion API Service Authentication (web.config)

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669/Web+Client+-+Installation+Guide

This snippet shows how to enable authentication for the Perfion API Service by setting the 'Perfion.SecureApiService' key to 'true' in the `appSettings` section of the web.config file. This ensures that API requests are executed in the context of an authenticated user, enhancing security.

```XML
<appSettings>
 <!-- removed for brevity -->
 <add key="Perfion.SecureApiService" value="true" />
 <!-- removed for brevity -->
</appSettings>
```

--------------------------------

### Updated Perfion Supplier Portal config.json for Web Client Connection

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243497822/Supplier+Portal+-+Installation

This snippet illustrates the required modifications to the config.json file to connect the Perfion Supplier Portal to a specific Perfion Web Client instance. The relative URLs are replaced with absolute URLs, using 'http://localhost:8031' as a placeholder for the Web Client's base URL.

```JSON
{
 "ServicesBaseUrl" : "http://localhost:8031/PerfionClientApi/",
 "ImageServerUrl": "http://localhost:8031/PerfionAPIService/Perfion/Image.aspx",
 "FileServerUrl": "http://localhost:8031/PerfionAPIService/Perfion/File.aspx",
 "ReportServerUrl": "http://localhost:8031/PerfionAPIService/Perfion/Report.ashx"
}
```

--------------------------------

### Sample XML Request for GetProducts

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332277/GetProducts

An example XML request demonstrating how to call the GetProducts method. This snippet shows how to specify a channel, a list of product keys, and which mappings to include in the response.

```XML
<Execute method="GetProducts" refreshconfiguration="true">
  <Parameter id="Channel" value="My Channel" />
  <Parameter id="Keys">
    <Value>DFGR1181</Value>
    <Value>DFGR1280</Value>
  </Parameter>
  <Parameter id="IncludeMappings">
    <Value>Item No</Value>
    <Value>Title</Value>
  </Parameter>
</Execute>
```

--------------------------------

### Configure Perfion API Service Database Connection String

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244330766/Installation+guide

This XML snippet demonstrates how to configure the database connection string within the Web.config file for the Perfion API Service. It specifies the data source, user credentials, initial catalog, and Perfion-specific user, password, and optional language settings.

```XML
<connectionStrings>
<add name="PerfionConn" connectionString="Data Source=(local);User ID=dbuser;Password=dbuser-password; Initial Catalog=PerfionDemo;PerfionUserID=admin;PerfionPassword=admin-password;PerfionLanguage=;"/>
</connectionStrings>
```

--------------------------------

### Install Perfion Scheduler as Windows Service

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244325717/Scheduler

This snippet provides the command to install the Perfion Scheduler as a Windows service using the .NET Framework's InstallUtil.exe utility. This command registers the service with the operating system, allowing it to run in the background and be managed via the Windows Services console, typically configured for automatic startup.

```Windows Command Prompt
InstallUtil.exe "Perfion.Scheduler.Service.exe"
```

--------------------------------

### Configure Perfion Web Client Base URLs in config.json

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Illustrates the initial structure of the `config.json` file used by the Perfion Web Client. This configuration defines the base URLs for various services such as the client API, image server, file server, and report server, along with a placeholder for a custom logo.

```JSON
{
 "ServicesBaseUrl" : "/PerfionClientApi/",
 "ImageServerUrl": "/PerfionAPIService/Perfion/Image.aspx",
 "FileServerUrl": "/PerfionAPIService/Perfion/File.aspx",
 "ReportServerUrl": "/PerfionAPIService/Perfion/Report.ashx"
 "customerDefinedLogo": ""
}
```

--------------------------------

### Perfion Execute Action Response Examples

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244330928/Perfion+Execute+Action+Query

Examples of responses from the Perfion Execute Action query, returning the ExecutionQueueId after an action has been successfully queued for execution.

```XML
<?xml version="1.0" encoding="utf-8"?>
<Response>
	 <Result>
				 <ExecutionQueueId>12</ExecutionQueueId>
	 </Result>
</Response>
```

```JSON
{
"ExecutionQueueId": 19
}
```

--------------------------------

### Azure App Service Plan Creation Parameters

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Defines the essential parameters for creating an Azure App Service Plan, which serves as the compute resource for Perfion applications. Key considerations include selecting the correct subscription, resource group, a unique name, and specifically 'Windows' as the operating system for Perfion products. Region consistency and appropriate pricing tier selection are also critical.

```APIDOC
App Service Plan Configuration:
  Subscription: Select the payment subscription for cost allocation.
  Resource Group: Choose where the App Service Plan should be stored.
  Name: Assign a clear and meaningful name.
  Operating System: Windows (only supported for Perfion products).
  Region: Select the same region for all related resources to minimize latency.
  Pricing Tier: Choose the SKU and size, balancing performance and cost.
```

--------------------------------

### API Method: GetSetup Configuration Retrieval

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332518/GetSetup

This documentation describes the `GetSetup` API method, which is primarily used for debugging purposes to retrieve the current configuration settings of the EC API. It details the method's parameters, sample request, and the structure of the XML response, including explanations for `ResourceMode`, `LogMode`, `LogHistory`, and `WorkFolder` settings.

```APIDOC
Method: GetSetup
Parameters: None
Purpose: Retrieves current EC API configuration settings for debugging.
```

```XML
<Execute method="GetSetup" />
```

```XML
<Response>
  <Result>
    <Settings>
      <Setting>
        <Name>ResourceMode</Name>
        <Value>ResourcesInAssembly | ResourcesInFile</Value>
      </Setting>
      <Setting>
        <Name>LogMode</Name>
        <Value>DisableLogging | EnableLogging</Value>
      </Setting>
      <Setting>
        <Name>LogHistory</Name>
        <Value>true | false</Value>
      </Setting>
      <Setting>
        <Name>WorkFolder</Name>
        <Value>string (path)</Value>
      </Setting>
    </Settings>
  </Result>
</Response>
```

```APIDOC
Settings Details:
  ResourceMode:
    Description: Controls whether EC API uses embedded files or files from 'WorkFolder'.
    Values:
      ResourcesInAssembly: Default. Uses built-in XML/XSL files.
      ResourcesInFile: Uses engine files from 'WorkFolder'. Requires valid 'WorkFolder' with needed files.
  LogMode:
    Description: Controls logging of intermediate results for debugging.
    Values:
      DisableLogging: Default. No logging.
      EnableLogging: Logs every request. Requires valid 'WorkFolder'. Logs stored in <Work folder>\Engine\_Debug-folder.
  LogHistory:
    Description: (From 4.6 2019 R3) Enables historical logging by timestamping log files.
    Values:
      true: Logs files with UTC-time prefix to <Work folder>\Engine\_Debug\History.
      false: Default.
    Note: Requires 'EnableLogging' to be active. Can consume significant disk space.
  WorkFolder:
    Description: Specifies the folder for EC to write to when 'ResourcesInFile' or 'EnableLogging' is active.
```

--------------------------------

### Example Perfion Query Results (XML/JSON)

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332821/Perfion+Query+Reference

This snippet illustrates the structure of data returned by a Perfion query, showing product details including features like ItemNumber, Image, and Description, along with metadata such as total execution time. Examples are provided in both XML and JSON formats.

```XML
<Data totalExecutionTime="00:00:00.1105121">
 <Features>
 <Image id="105" language="EN" caption="Image" group="All" dataType="Image" />
 <Description id="148" language="EN" caption="Description" group="All" dataType="Text" />
 <Product id="100" language="EN" caption="Product" group="All" dataType="String" />
 </Features>
 <Product id="853" parentId="0" brand="Normal" order="0" >
 <Value seq="0" modifiedDate="2016-07-12T11:01:22.93">TE717209RW</Value>
 <Image seq="0" modifiedDate="2019-11-27T09:09:56.437" string="MCSA00992759_SE_K_12_KV7_EQ7_TE717209RW_picture_KF1_coffeemachine_ENG_230215_def_(48).jpg.jpg" fileSize="18967" fileModifiedDate="2019-11-27T09:09:50.123" width="300" height="300" widthDpi="48" heightDpi="48">5fd1e0be-56bd-407f-bce8-6e6d35f1e792</Image>
 <Description language="EN" seq="0" modifiedDate="2017-11-23T13:48:44.45">Siemens TE717209RW is a beautiful piano black fully automatic espresso machine from Siemens EQ7 series. With just a tap you make cappuccino, latte, espresso or coffee.
This model has the smart and practical "My Coffee" function so you can configure the relationship between milk and espresso in your drink - you could choose up to 80% coffee, so you have extra power and heat your milk drink!
The grinder automatically adjusts itself to the coffee blend you use. And the individual programming ensures that up to 6 people can have their own coffee profile, where each button is programmed after the personal wishes.</Description>
 </Product>
 <Product id="858" parentId="0" brand="Normal" order="0" createdDate="2016-07-12T11:15:10.52" modifiedDate="2020-04-21T14:59:11.317">
 <Value seq="0" modifiedDate="2016-07-12T11:15:18.887">TE806201RW</Value>
 <Image seq="0" modifiedDate="2019-11-27T09:09:56.437" string="MCSA01088244_SE_K_12_KV8_EQ8_TE806201RW_picture_KF1_machine_ENG_120615_def_(48).jpg.jpg" fileSize="36135" fileModifiedDate="2019-11-27T09:09:50.17" width="452" height="480" widthDpi="48" heightDpi="48">004ede8a-592a-4466-90ae-f5f97aa117dc</Image>
 <Description language="EN" seq="0" modifiedDate="2016-07-12T11:50:54.053">EQ8 series espresso machines in a class by itself, with a beautiful stainless steel design and an intelligent heating system: sensoFlow-ensuring system constant brewing temperature and thus guarantees maximum enjoyment espresso every time.
Siemens EQ8 also the smart aroma double shot mode makes extra strong coffee less bitter because the machine grinds and brews twice with 19 bar.
Furthermore ensures EQ8 an exclusive convenience through OneTouch Feature creamCleaner, cup warmer, lighting and insulated milk container.</Description>
 </Product>
</Data>
```

```JSON
{
 "Data": {
 "totalExecutionTime": "00:00:00.0882522",
 "Features": [
 { "name": "Image", "id": 105, "language": "EN", "caption": "Image", "group": "All", "dataType": "Image" },
 { "name": "Description", "id": 148, "language": "EN", "caption": "Description", "group": "All", "dataType": "Text" },
 { "name": "Product", "id": 100, "language": "EN", "caption": "Product", "group": "All", "dataType": "String" }
 ],
 "Items": [
 { "featureId": 100, "featureName": "Product", "id": 853, "parentId": 0, "brand": "Normal", "order": 0,
 "Values": [
 { "featureId": 100, "featureName": "Value", "seq": 0, "modifiedDate": "2016-07-12T11:01:22.93", "value": "TE717209RW" },
 { "featureId": 105, "featureName": "Image", "seq": 0, "modifiedDate": "2019-11-27T09:09:56.437", "string": "MCSA00992759_SE_K_12_KV7_EQ7_TE717209RW_picture_KF1_coffeemachine_ENG_230215_def_(48).jpg.jpg", "fileSize": 18967, "fileModifiedDate": "2019-11-27T09:09:50.123", "width": 300, "height": 300, "widthDpi": 48, "heightDpi": 48, "value": "5fd1e0be-56bd-407f-bce8-6e6d35f1e792" }

```

--------------------------------

### Perfion Action Map Use Cases and Examples

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466243/Guides+and+Manuals

A comprehensive collection of practical examples demonstrating various data import, export, synchronization, and utility operations that can be configured and executed using Perfion Action Maps.

```APIDOC
Import from Excel (data and images)
```

```APIDOC
Import from XML (eCl@ss data, BMEcat format)
```

```APIDOC
Import images from hotfolder to image library
```

```APIDOC
Import images from hotfolder to products
```

```APIDOC
Export to Excel (data and images)
```

```APIDOC
Export to Excel with dynamic Category
```

```APIDOC
Export to XML (custom format)
```

```APIDOC
Change Encoding of Export or File
```

```APIDOC
Sync NAV items to Perfion
```

```APIDOC
Sync BC items to Perfion (OData)
```

```APIDOC
Move invalid and unsellable product
```

```APIDOC
Send email with new products
```

```APIDOC
Start Notepad and open Excel file
```

```APIDOC
Start application with settings
```

```APIDOC
Remove HTML tags from text
```

```APIDOC
Zip a list of product images into one file
```

```APIDOC
Calling an Action on selected products via a Report
```

```APIDOC
Calling REST API with Action
```

```APIDOC
Use Global Table To Retrieve Data From Loop
```

```APIDOC
Import Files From A Several Nested Folders
```

```APIDOC
Assign EAN Codes From A List
```

```APIDOC
Save Product Sheet Offline
```

```APIDOC
SELECT.XSLT Example – Using multiple data-sources
```

```APIDOC
Using Global Variables
```

```APIDOC
WRITE.* Property "To"
```

--------------------------------

### Uninstall Perfion Application Server Windows Service

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244325971

This command uninstalls a previously installed Perfion Application Server Windows service using InstallUtil.exe. It must be run from an administrator command prompt in the service's installation folder. The service to be uninstalled is identified by the 'ServiceName' key in the InstallUtil.exe.config file present in that directory.

```Command Line
InstallUtil.exe "Perfion.ApplicationServer.Service.exe" /uninstall
```

--------------------------------

### Example Perfion Query Results

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/244332821

This snippet provides an example of the data structure returned by a Perfion Query, specifically showing product information including ItemNumber, Image, and Description. It illustrates both XML and JSON formats of the query results.

```XML
<Data totalExecutionTime="00:00:00.1105121">
 <Features>
 <Image id="105" language="EN" caption="Image" group="All" dataType="Image" />
 <Description id="148" language="EN" caption="Description" group="All" dataType="Text" />
 <Product id="100" language="EN" caption="Product" group="All" dataType="String" />
 </Features>
 <Product id="853" parentId="0" brand="Normal" order="0" >
 <Value seq="0" modifiedDate="2016-07-12T11:01:22.93">TE717209RW</Value>
 <Image seq="0" modifiedDate="2019-11-27T09:09:56.437" string="MCSA00992759_SE_K_12_KV7_EQ7_TE717209RW_picture_KF1_coffeemachine_ENG_230215_def_(48).jpg.jpg" fileSize="18967" fileModifiedDate="2019-11-27T09:09:50.123" width="300" height="300" widthDpi="48" heightDpi="48">5fd1e0be-56bd-407f-bce8-6e6d35f1e792</Image>
 <Description language="EN" seq="0" modifiedDate="2017-11-23T13:48:44.45">Siemens TE717209RW is a beautiful piano black fully automatic espresso machine from Siemens EQ7 series. With just a tap you make cappuccino, latte, espresso or coffee.
This model has the smart and practical "My Coffee" function so you can configure the relationship between milk and espresso in your drink - you could choose up to 80% coffee, so you have extra power and heat your milk drink!
The grinder automatically adjusts itself to the coffee blend you use. And the individual programming ensures that up to 6 people can have their own coffee profile, where each button is programmed after the personal wishes.</Description>
 </Product>
 <Product id="858" parentId="0" brand="Normal" order="0" createdDate="2016-07-12T11:15:10.52" modifiedDate="2020-04-21T14:59:11.317">
 <Value seq="0" modifiedDate="2016-07-12T11:15:18.887">TE806201RW</Value>
 <Image seq="0" modifiedDate="2019-11-27T09:09:56.437" string="MCSA01088244_SE_K_12_KV8_EQ8_TE806201RW_picture_KF1_machine_ENG_120615_def_(48).jpg.jpg" fileSize="36135" fileModifiedDate="2019-11-27T09:09:50.17" width="452" height="480" widthDpi="48" heightDpi="48">004ede8a-592a-4466-90ae-f5f97aa117dc</Image>
 <Description language="EN" seq="0" modifiedDate="2016-07-12T11:50:54.053">EQ8 series espresso machines in a class by itself, with a beautiful stainless steel design and an intelligent heating system: sensoFlow-ensuring system constant brewing temperature and thus guarantees maximum enjoyment espresso every time.
Siemens EQ8 also the smart aroma double shot mode makes extra strong coffee less bitter because the machine grinds and brews twice with 19 bar.
Furthermore ensures EQ8 an exclusive convenience through OneTouch Feature creamCleaner, cup warmer, lighting and insulated milk container.</Description>
 </Product>
</Data>
```

```JSON
{
 "Data": {
 "totalExecutionTime": "00:00:00.0882522",
 "Features": [
 { "name": "Image", "id": 105, "language": "EN", "caption": "Image", "group": "All", "dataType": "Image" },
 { "name": "Description", "id": 148, "language": "EN", "caption": "Description", "group": "All", "dataType": "Text" },
 { "name": "Product", "id": 100, "language": "EN", "caption": "Product", "group": "All", "dataType": "String" }
 ],
 "Items": [
 { "featureId": 100, "featureName": "Product", "id": 853, "parentId": 0, "brand": "Normal", "order": 0,
 "Values": [
 { "featureId": 100, "featureName": "Value", "seq": 0, "modifiedDate": "2016-07-12T11:01:22.93", "value": "TE717209RW" },
 { "featureId": 105, "featureName": "Image", "seq": 0, "modifiedDate": "2019-11-27T09:09:56.437", "string": "MCSA00992759_SE_K_12_KV7_EQ7_TE717209RW_picture_KF1_coffeemachine_ENG_230215_def_(48).jpg.jpg", "fileSize": 18967, "fileModifiedDate": "2019-11-27T09:09:50.123", "width": 300, "height": 300, "widthDpi": 48, "heightDpi": 48, "value": "5fd1e0be-56bd-407f-bce8-6e6d35f1e792" }
 ]
 }
 ]
 }
}
```

--------------------------------

### Azure App Service (API App) Creation Parameters

Source: https://perfion.atlassian.net/wiki/spaces/PIM/pages/243466243/Guides+and+Manuals/pages/243466669

Outlines the necessary information for creating an Azure App Service instance specifically designed to host Perfion APIs (e.g., SOAP API, Client API). This includes defining a unique app name that also serves as the access URL, selecting the billing subscription and resource group, and associating it with an existing App Service Plan. CORS policy configuration is highlighted as a post-creation step.

```APIDOC
App Service (API App) Configuration:
  App Name: Unique name for the API, also used as its access URL.
  Subscription: Select the subscription for billing purposes.
  Resource Group: Specify where the App Service should be stored.
  App Service Plan: Choose the appropriate App Service Plan under which the API will run.
  CORS Policy: Configure cross-origin access settings (post-creation).
```
Tokens:
Raw