Add a REST service manually in Zero Copy Connector for ERP

When adding an entity to a model using REST, if the service you need isn't listed, add the service manually in Zero Copy Connector for ERP (Enterprise Resource Planning).

Before you begin

Role required: sn_erp_integration.erp_admin

Complete the following before adding a service manually:

• Enable the sn_erp_integration.enableModelModification property. For more information, see Install Zero Copy Connector for ERP.
• Create a connection and credential alias, specifying HTTP as the Connection type. For more information, see Create a Connection & Credential alias.

• Create an HTTP connection for the service. Add the connection alias that you created and the connection URL. On the Attributes tab, select Patch or Put in http_method_for_update and specify the odata_ping_url.

  For more information, see Create an HTTP(s) connection.

• Create a system that uses the HTTP connection. For more information, see Create an ERP system in Zero Copy Connector for ERP. On the system record, confirm that the heartbeats are successful and the retrieval status is complete. If any have failed, select Restart data retrieval.
• If you plan to connect using a URL, copy the metadata URL from the ERP system to which you're linking. Use the relative URL containing only the path following the domain, for example, v2/northwind/northwind.svc/$metadata.

Procedure

1. Navigate to All > Zero Copy Connector for ERP > Zero Copy Connector for ERP Home.
2. Open the model page by selecting the models icon. in the side panel.
3. Select the model to which you want to add an operation entity.
4. In the ERP system field, verify that the correct system is selected.
5. Select the Manage model button.
6. Select an operation.
   If you don't have an operation, see Add an operation to a model in Zero Copy Connector for ERP.
7. Select Select entity on the Manage entities tab.
8. In Select type, select REST.
9. Select + Add service manually.

   

   Note:

   If you have already added the service, but want to select a different endpoint, you can directly search for the service by name. You don't have to add the metadata URL or upload the metadata file again.
10. If using a metadata URL, follow these substeps (if uploading a metadata file, go to the next step).
    1. Select Use Swagger/OpenAPI URL.
    2. In the Swagger/OpenAPI Version field, select a version such as 2.0 or 3.0.
    3. Paste in a Swagger/OpenAPI URL and select outside of the field.
    4. In the Service name field, verify that a name is created automatically.

       You can edit the service name as needed.

       

11. If uploading a metadata file, follow these substeps.
    1. Select Upload Swagger/OpenAPI file.
    2. In Swagger/OpenAPI Version, select a version such as 2.0 or 3.0.
    3. Select Attach File.
    4. Select a JSON or YAML file and then select Open.
    5. Enter a Service name.

       You can download, edit, or delete the file by selecting an icon.

       

12. When finished, select Add service.

    A background job named Additional Service Handler runs.

    Note:

    If an issue occurs, an error message appears. Select Flow context for more information. You can also view execution details in Workflow Studio.

    

    The service is added to the entity record.

13. In Select the endpoints, search for and select an endpoint.

    The endpoints available in an operation depend on the HTTP method associated with the operation type:

    • Read operations display GET endpoints.
    • Create operations display POST endpoints.
    • Update operations display PATCH, PUT, and other update endpoints.

    

14. When finished, select Add entity.