Manage input parameters for an ERP Data Hub model operation

Specify how fields on the ERP (Enterprise Resource Planning) system map to input parameters and their values to define the inputs for an operation that reads or updates the system of record from ERP Data Hub.

Before you begin

Role required: sn_erp_integration.erp_admin, sn_erp_integration.erp_user

About this task

If you're already in the process of managing a model and ready to specify inputs, you can skip to step 5.

Procedure

1. Navigate to All > ERP Data Hub > ERP Data Hub Home.
2. Open the ERP model page by selecting the ERP model icon () in the side panel.
3. Select the model with the operation that you want to add inputs to.
4. Select the Manage model button.
5. Open a model operation.
   If you do not have a model operation, add one to the model. For more information, see Add an operation to a model in ERP Data Hub.
6. Open an entity.
   If you do not have an entity, add one to the operation. For more information, see Add a read, update, or create entity to a model in ERP Data Hub
7. Select Specify inputs.
   The required parameters for the operation appear in both of the following places:

   • The Operation parameters section, where you define any default values to use if the operation fails.
   • The Tables/Function call section, where you define the parameters the operation uses. The Table section appears for read operations, and the Function call section appears for BAPI (Business Application Programming Interface) operations.

   Figure 1. Manage inputs

   

8. Define whether the operation inputs are required in the Query validation rule field.
   • All inputs are mandatory
   • At least one input is mandatory
   • No inputs are mandatory
9. Review the required and optional parameters that are already defined for the operation and note what you must add.
10. Define a new input parameter to be sent when querying the ERP system.
    For table read operations, a Tables section appears in the mapped table fields section for each defined table entity. Make sure that you're adding the parameter for the correct table.

    Note:

    It doesn't matter what order you define parameters in. ERP Data Hub displays optional parameters in alphabetical order when you save.
    1. Select the add icon (+) next to the last-defined parameter.
    2. Fill in the fields to define the parameter.

       Table 1. Fields to define an input parameter

       Field	Description
       Field name	Name of the field from the ERP system that you're defining as a parameter. ERP Data Hub automatically retrieves fields from the table defined in the operation entity.
       Data type	(Read-only) Automatically populated value that specifies the type of data the parameter contains.
       Type	Definition of how the parameter is sent. Input parameters have their Mapped value automatically populated. Constant defines a parameter whose value never changes, for example, to use as filter criteria. You must specify the value in the parameter's Mapped value field. Join (Table read operations only) indicates that you're creating a table join. For more information, see Add joins between ERP tables.
       Mapped value	Specific value of the parameter. For Input parameters, accept the system-generated name. For Constant parameters, enter a set value that's always sent for the parameter. For Join parameters, select the field to join the parameter with. For details on creating joins, see Add joins between ERP tables.

    If you're adding a complex, nested parameter, such as an address that includes several other parameters (one for street, one for city, one for country), ERP Data Hub automatically identifies that it needs additional related parameters and creates new, nested parameter rows that you must then populate with the related values. You can nest only parameters with Object or Array as the Data type.
11. Include the newly defined parameter in the Output parameters section by selecting the automap icon ().
    ERP Data Hub automatically updates the Mapped value for the Tables/Function call parameter, and adds a row for the parameter to the Output parameters section.
12. Optional: Specify a Default value to be used for the parameter in the newly added Optional parameter row in the Output parameters section.
    The Default value is used when the input parameter isn't specified in the query.
13. Optional: Remove any optional parameters that you don't need when querying the ERP system by selecting the remove (-) icon.
    You can't remove any Required parameters.
14. Make any additional edits to existing parameters.
15. Select Save.

What to do next

Next, check the output parameters for the operation and update as needed. For more information, see Choose output parameters for an ERP model.