Skip to main content

M3 API Component

The M3 API component connects to Infor M3 and runs MI (Management Interface) transactions, for listing, adding, updating or deleting records. It is the main component for any workflow that works with M3 business data.

Use it when a workflow should read data from M3, or send changes to M3, such as updating a batch of items from a spreadsheet. To only offer M3 data as a pick list in another workflow, use M3 Fetch instead. For systems other than M3, use REST API.

It is a VXL Live component: you build it in the Vince Platform workflow editor, and the workflow is used from VXL Live. A workflow can contain one M3 API step (or one M3 Fetch step, which is used for lookups), not both.

Example: update 100 items from Excel​

You have a spreadsheet with 100 rows, each with an item number and a new item description, and want to update them in M3.

  1. Build the workflow: Trigger → M3 API → Excel.
  2. In the M3 API step, add the transaction MMS200MI / UpdItmBasic.
  3. Set the input Item number and the new description input to the source Excel.
  4. In the Excel step, map those inputs to the columns of your sheet. Also map an output such as Workflow message to a column to see the result per row.
  5. In VXL Live, open the workflow, fill in the sheet and run it. The transaction runs once per row, and the result of each row appears in the sheet.

Add transactions​

The step needs an environment with an M3 connection. If none is selected yet, the step shows Select Environment.

  1. Click Click here to add first API call. Later you can click a + between or after transactions to insert another one at that position.
  2. Pick a Program, then a Transaction. Select Include general transactions to also list general ones.
  3. Optionally give the transaction a Name. Otherwise the transaction's own description is used.

Each transaction is shown as a card with its Inputs (the values sent to M3) and Outputs (the values M3 returns). Use the search box at the top of a card to find a field, and the menu next to the card name to Copy, Set critical or Delete the transaction. Click the name to rename it.

note

Required inputs that are not filled in are reported when you save, and the workflow shows an error until they are.

Field input sources​

Click the cog icon next to an input to choose where its value comes from. To set several inputs the same way, click each one to select it, then click the cog in the Inputs header. The icon in front of an input shows its state: a warning for a required input with no source, a source icon once it is set, and a question mark for an optional input left empty.

SourceDescription
ClientThe user types the value when running the workflow. Not available to scheduled runs
ApiThe value comes from an output of an earlier transaction in the same step. Only offered from the second transaction onwards
ExcelThe value is read from a column of the Excel file. Only offered in workflows that read rows from an Excel file
ConstantA fixed value set when you build the workflow
EventThe value comes from a column of the table that triggers the workflow. Only offered when the workflow has an Event trigger. Pick the Event column
Current dateToday's date when the workflow runs
TagA tag on the account of the user who runs the workflow
caution

Client needs someone to type the value, so it cannot be used in scheduled workflows. Use Constant or another source that needs no input instead.

To pass a value from one transaction to the next without opening the cog, drag an output of the earlier transaction onto an input of the later one.

Outputs​

The Outputs section lists the fields M3 returns. Outputs that the workflow already uses, for example in a later transaction or an Excel column, are listed first with an icon showing how they are used.

caution

M3 limits how many records a list transaction returns, and the limit depends on the environment (M3 CE or on-prem) and the program. Any Search transaction (for example EXPORTMI/Search or CRS610MI/Search) returns at most 1,000 records, even if maxReturnedRecords is set higher. See Reading Many Records from M3 for which limit applies when.

Configure execution​

Click Configure execution at the top of the step to set:

SettingDescription
Max rowsHow many rows the step handles. Select Unlimited to remove the limit. If you expect more than 99,999 records, choose Unlimited
M3 CompanyThe default company for the transactions: Client (entered when running), Constant (a fixed number) or left empty
M3 DivisionThe default division, set the same way

Workflows that read rows from Excel​

When the workflow reads its rows from an Excel file (an import), a few more options appear:

  • Dependencies: from the second transaction onwards, open Dependencies in the card menu to run a transaction only if another one runs successfully, or only if it fails. Use it to create an order header first and add lines only when it succeeded.
  • Extra grouping: open Extra grouping in the card menu, or tick Group by this field on an input, to combine rows that share the same value into one call, for example one order with several lines.
  • Define start-end run: marks the first transaction as the start and the last one as the end of the run.
Last updated on