VXL - Net Change Report - 2.2019.09.20
Vince |
VXL - Net Change Report - 2.2019.09.20 |
Date: 2019-09-20 |
Santhosh Balakrishna, Mikael Malmberg |
Table of Contents
Data type
Data type Decimal
Is Critical
Export
Import
Additional options added to Input Fields
Re-Use Input Field from Previous Transaction
Cell
With predefined excel file
Without predefined excel file
UserID
Current Date
New features: Output Cell
With predefined excel file
Without predefined excel file
Support for EXPORTMI – Select
Filter on Import
Example 1 (filter applies for the specific ImportDetail):
Example 2 (filter applies for API-transactions within the step):
VXL Report
Appendix
Users
Role-Users
Role-Functions
Role-Users-Functions
User-Functions
View by Label
Activate/deactivate User
Support for M3 Web Service (MWS)
How to find the Web Service XML-file
M3 Display Program (type = MPD)
SQL Query (type = SQL)
Enhancement Function Documentation
Mandatory Input Fields Are Highlighted
Enhancement to Labels
Download of the Function Template
Enhancement File Extensions
XML-Elements Not Supported by the Configurator
Associate End Run with any Start Run
Setup of the function
Enhancement made to End Run
Require All Details Success
Support for M3 CE
Setup of Cloud Edition
Establish Secure Connection
Upload Credentials to VPM
Setup of TCP/IP
Expand without Excel-file
Data type
Data type column for Input fields is editable with the following options:
- String
- Data
- Integer
- Decimal
Please note that the default data type is set according to how its defined in the API-transaction.
Data type Decimal
For data type Decimal and additional column called Dec. is added in which the number of decimal places can be added (default value is 2).
A checkbox is also added called Comma in which if checked, the support for Decimal Separator as Comma is set as true.
Is Critical
The "Is Critical"-parameter controls two objects:
- Export
- Import
Export
If a List-API uses associated API transactions (Get-API) the "Is Critical"-parameter how the Get-API should be executed. If the selected the Get-API run in sequence with the List-API.
Import
Controls which API in an Import Task that should update the M3 Message column.
Additional options added to Input Fields
New options have been added to Input fields:
- Re-use input field from previous transaction
- Cell
- UserID
- Current Date
Re-Use Input Field from Previous Transaction
The input fields from the main API-transaction can be used as input fields to associated API-transactions:
Cell
When Source = Cell is selected the input value to the API-transaction is retrieved from the cell specified.
With predefined excel file
When Source = Cell is selected the following must be entered:
- Value = the cell from which the value is read
Without predefined excel file
When Source = Cell is selected the following must be entered:
- Value = the cell from which the value is read
- Source Cell Constant = the value that is read
- Label Cell
- Label
UserID
Current UserID is used as input to the API-transaction.
Current Date
Current Data is used as input to the API-transaction.
New features: Output Cell
When output cells are defined data will be written to the specified cells. It is possible to add one or several output cells.
With predefined excel file
The labels are retrieved from the predefined excel file.
Without predefined excel file
The label for each cell is entered in the configurator.
Support for EXPORTMI – Select
For reference please read Net Change 9966 – Generic List API available on Infor Xtreme.
To make the an M3 table available on the VPM it is must be imported from M3. Note that it is only the table definition that is imported (i.e. fields including definitions).
Click on the Update Repository-button and enter your M3 credentials:
Enter the M3 tables to be imported and press the OK-button:
Note: You can also enter the table names as semicolon separated string in the Tables field and on tab out it gets added to the list below (for ex: MITMAS;MITBAL;MITFAC;MITTRA;MITLOC).
Once the import is completed the following message will be prompted:
Go to the Configurator and create an Export-task:
Enter:
- Function name
- API Environment
- Type = Export data from M3 BE
Press the Next-button:
Select an excel file or let the Configurator generate one. Press the Next-button:
Click the search-button:
Search for EXPORTMI and all table that have been imported are listed as transactions. Select MITMAS and press the Select-button:
Enter a Separator character (make sure that is unique, so it doesn't interfere with the data retrieved):
Add output-fields:
The WHERE-statement is generated using the Filer fields:
Execute the function:
Filter on Import
Filters are used to control if and when a specific API or group of APIs should be ran.
Example 1 (filter applies for the specific ImportDetail):
OIS017MI – DelBasePrice is only executed for lines where column A is equal to DEL.
Example 2 (filter applies for API-transactions within the step):
OIS017MI – AddBasePrice and OIS017MI – UpdBasePrice are only executed for lines where the Sales Price in column D is greater than 0 (zero).
VXL Report
A set of reports have been added to the VPM which makes it possible for Company Administrators analyze the company setup with regards to:
- Users
- Role-Users
- Role-Functions
- Role-Users-Functions
- User-Functions
The reports are launched from the Administration-tab:
Select which report to run in the Report Type-dropdown:
It is possible to search directly in the report or by downloading the report as Excels-file by pressing the Download-button:
Appendix
Users
Lists all the users within a company:
- Email id
- Name
- Company admin
- External user
Role-Users
Lists the connection between:
- Role
- Email id
- Name
Role-Functions
Lists the connection between:
- Role
- Function/Version
Role-Users-Functions
Lists the connection between:
- Role
- Email id
- Name
- Function/Version
User-Functions
Lists the connection between
- Email id
- Name
- Role
- Function
View by Label
In the VPM it is possible to view functions by labels:
Activate/deactivate User
It is possible to activate/deactivate a user:
Support for M3 Web Service (MWS)
The following types are supported:
- M3 Display Program (type = MPD)
- Only support for Import
- SQL Query (type = SQL)
- Only support for Export
- No support for Expand
Please note:
M3 Web Service is not supported in Cloud Edition.
How to find the Web Service XML-file
Go to ION Grid Management Pages > MWS > Management Pages:
Click on List:
Click on services:
Click on your web service and click on the WSDL Address (the Web Service is opened in a browser):
Right-click and select Save as..
Press Save and the Web Service is ready to be upload to the VPM Configurator.
M3 Display Program (type = MPD)
Enter:
- Name
- API Environment
- Type = Import data to M3 BE
Press the Next-button.
Select an excel file and enter:
- Header start row
- Data start row
- Start column
- End column
- Message column
- Type = MWS
- Select xml-file
Press the Next-button.
Add steps:
Add-transaction
Field Name, MWS Field and MWS Program are retrieved from the Web Service XML-file.
Update-transaction
Field Name, MWS Field and MWS Program are retrieved from the Web Service XML-file.
Execute the function:
SQL Query (type = SQL)
Enter:
- Name
- API Environment
- Type = Export data from M3 BE
Press the Next-button.
Select without excel file and enter:
- Header start row
- Data start row
- Type = MWS
- Select xml-file
Press the Next-button.
Select transaction and enter source for the Field name (input field):
Output fields are mapped automatically when the excel-file is created by the configurator:
Execute the function:
Enhancement Function Documentation
In each function it possible to add an Information URL which makes it possible to open documentation (stored for example on SharePoint) directly from the VXL client by clicking
the link ( ):
Mandatory Input Fields Are Highlighted
Mandatory input fields are highlighted in VPM and VXL according definition on the API-transaction:
Enhancement to Labels
Labels are used to organize the function repository in VPM and VXL. One function can have one or several labels. The functions are displayed according to an OR-condition meaning that if function has one of the labels it will be displayed.
Download of the Function Template
It is now possible to download the function template (i.e. the excel file associated with the function) directly from VXL by clicking on the download-button (
Enhancement File Extensions
In earlier release VPM couldn't handle file extensions in upper case. If files are added in uppercase VPM convert them to lowercase.
Note: For the files that are already existing in VPM, the user will have to open the function for Edit and click on Save & Close and that will take care of changing the file extensions to lower case.
XML-Elements Not Supported by the Configurator
When editing a Function containing XML-elements not supported by the Configurator a warning be prompted. The warning contains information about which XML-elements that aren't supported and appropriate actions.
Associate End Run with any Start Run
When building a function that runs a set of of API-transactions in sequence to create one or several packages that consist of a Header (ImportHeading, StartRun) and associated lines (ImportDetail) there is a parameter that controls when the confirmation transaction should be executed for each package and to which Header (ImportHeading, StartRun) it should be executed for. This parameter is called End Run.
Example:
In the example below customer orders are created using the following APIs:
Sequence | API-transaction | Type | Group Columns |
1 | OIS100MI – AddBatchHead | ImportHeading/StartRun | A, B, C, D, E |
2 | OIS100MI – AddBatchLine | ImportDetail | |
3 | OIS100MI - Confirm | ImportHeading/EndRun | A, B, C, D, E |
Sample data and file layout:
Since OIS100MI – AddBatchHead is ran once per unique combination of the following columns (controlled by Group By):
- A = Customer
- B = Order type
- C = Facility
- D = Warehouse
- E = Requested delivery date
Two customer orders will be created:
Customer order 1:
- Customer = MM02
- Ordre type = M01
- Facility = A01
- Warehouse = 001
- Requested delivery date = 2019-09-25
- 6 associated lines
Customer order 2:
- Customer = MM02
- Ordre type = M01
- Facility = A01
- Warehouse = 001
- Requested delivery date = 2019-10-02
- 3 associated lines
Packages 1 Customer order 1:
Package 2 Customer order 2:
Execute the function:
Result:
OIS300:
OIS101: 0011000591
OIS101: 0011000592
Setup of the function
Import steps:
OIS100MI – AddBatchHead
Group by controls how OIS100MI – AddBatchHead should be ran, i.e. for every unique combination of column A, B, C, D the API is ran.
OIS100MI – AddBatchLine
The associated lines will be automatically be connected via the common keys (i.e. column A, B, C, D and E).
OIS100MI - Confirm
By selecting the Is End Run-checkbox and selecting OIS100.AddBatchHead for transaction=OIS100MI.Confirm will result in that the OIS100MI – Confirm will be executed once the last line in the package has been submitted.
Enhancement made to End Run
Require All Details Success
Option | Condition |
Select | End Run will always run |
True | End Run will run if ALL ImportDetails return OK |
False | End Run will run if ONE ImportDetail return NOK |
Support for M3 CE
VXL now has extended its support from TCP/IP to also include support Cloud Edition. The configuration is done per M3 environment connected to the company.
Setup of Cloud Edition
Establish Secure Connection
To establish a secure connection between M3CE and VXL using Infor ION API gateway, you need to do the following steps.
Go to Infor ION API setup:
Open Authorized Apps:
From this screen you can create a new connection by pressing the plus sign:
Enter the following information:
- Name
- Type: Windows Desktop
- Description
- Redirect URL: https://vpm.vincesoftware.org/redirectvxl
- Download URL: https://vpm.vincesoftware.org
Then save connection (top of page).
The next step is to Download the Credentials. Note that if it is stated that the Redirect URL is invalid, that should not cause any problems.
When the Credentials has been downloaded it must be uploaded on the VPM server.
Upload Credentials to VPM
Go to https://vpm.vincesoftware.org and login:
Go to the Environments-tab:
Click on the +Environment-button:
Enter the following information:
- Name
- M3 Environment: Cloud Edition
- Protocol
- Server name/IP
- Press the Browse button located to the left Authorization File to upload the Credentials.
The Server name/IP is found by logging into you M3 Portal and going to Infor ION API and open InforM3 APIs:
All URLs are listed:
Copy the marked part, and past it into Server name/IP:
https://mingle-ionapi.eu1.inforcloudsuite.com/VINCE_DEM/M3
The remaining details is then retrieved from the Credentials file:
Note that Default M3 userid, Description and color code are optional fields.
Press the Save-button to finish the setup.
Parameter | Description |
Name | Name of the environment |
M3 Environment | Select Cloud Edition |
Protocol | Select protocol (https or http) |
Server name/IP | See instruction above how to find this |
Port number | n/a |
API URL | /m3api-rest/execute/ |
Rest API URL | Concatenation of protocol, Server name/IP and API URL |
Authorization file | Upload of the Credential file .json* or {}.ionapi{*}). |
Authorization URL | From the Credential file (.json* or {}.ionapi)* |
Token URL | From the Credential file (.json* or {}.ionapi)* |
Client ID | From the Credential file (.json* or {}.ionapi)* |
Client secret | From the Credential file (.json* or {}.ionapi)* |
Redirect URL | From the Credential file (.json* or {}.ionapi)* - (The URL to which it will get redirected once we login to M3 CE from VXL) |
Default M3 userid | Optional |
Description | Optional |
Color code | Optional |
Setup of TCP/IP
Enter the following information:
Parameter | Description |
Name | Name of the environment |
M3 Environment | Select TCP/IP |
Server name/IP | |
Port number | |
Default M3 userid | Optional |
Description | Optional |
Color code | Optional |
Expand without Excel-file
In an Expand task without excel-file the message column must be selected along with other fields: