The configuration of services are documented in this section, broken into the following 7 parts:
Basic Fields
List View Fields
View/Edit Fields
Create / Delete Fields
Submit Fields
Restricted Permissions Fields
Field Configuration Syntax
(Please be aware that the service configuration fields are not addressed in the same order that they are shown in the user interface.)
Basic Configuration Fields
The following fields are part of the basic service configuration
Title The user defined display name of the service.
ERP Lists the supported ERP systems (Select appropriate ERP).
Service Base Url Is the base URL of the service endpoint. This will vary depending on the underlying ERP or data source. For integrations that use CDATA, it will be https://dpportalapi.dynamicpoint.com/api.rsc/
For ERP applications that offer native ODATA endpoints, such as Dynamics Business Central, it will be the base of the REST endpoint, such as https://api.businesscentral.dynamics.com/v2.0/9409a44d-fc40-4daf-8cbd-33a8d837f52c/Production/ODataV4/
Company/Resource The name of the SQL table, View or page within the ERP. To specify a company variable, the following syntax can be used: Company(‘{0}’)/
Report Service Configuration This will be a drop down of those reports configured in RS Configuration.
Image Service Configuration This will be a drop down of those image services configured in RS Configuration.
Payment Setting This will be a drop down of the payment settings that have been configured.
Child Resource View for any line items related to the resource.
Filter Filter options as defined by system services will be available in the drop down.
Filter Field This is the name of the field from the resource on which the actual filtering will be done. (Must correspond to Filter Key).
Clause This defines what would be the clause between the Filter and the additional filters for the query if both are defined for the current service. Otherwise this field is not applicable.
The following options are available:
None
And
Or
Additional Filters Any valid OData filters can be specified here. No processing will be done over the contents of this field. It will be appended to the query in the way it is specified here. Required if And or Or was selected for Clause, otherwise it is not applicable.
Parameters Any additional parameters that are needed for the query can be added here.
Records per Page Number of records that should be displayed in the grid when rendering the results of the current service.
Credential This will be a drop down all credentials defined for the current tenant.
Enable Export Enables the button that allows the service results to be exported to Excel.
Open Create Form on Initial Load If this is selected, the open form will appear automatically when the service is first loaded.
Default Select if desired as the default service shown in the app.
Active Uncheck in the event that the service is no longer needed.
List View Fields
The following fields define the data to be returned in the list/grid view of the portal:
List Fields Resource fields displayed on the header grid.
List Sort Fields Designate those list fields you would like the data sorted by when applicable. (use asc or des).
Child Grid List Fields Child Resource fields displayed in the line item grid when applicable.
Child Grid List Sort Fields Designate those list fields you would like the data sorted by when applicable. (use asc or des).
The wrench icon can be selected to choose the list fields from the service metadata.
View/Edit Fields
The following fields define the data to be returned when the view of a specific line item is selected from the grid. In the drill down, fields can be defined read-only or editable.
View/Edit Form Fields Resource fields available in header drill down (can be read only or editable).
Child Grid View/Edit Form Fields Child Resource fields available in line item drill down (can be read only or editable).
Enable Edit in Parent Grid This must be selected in order to allow a user drill into a line item.
Enable Edit in Child Grid This must be selected in order to allow a user drill into a line item.
View / Edit Top Text Static text to be displayed on the top of the view / edit form.
View / Edit Bottom Text Static text to be displayed on the bottom of the view / edit form.
Child Grid View / Edit Top Text Static text to be displayed on the top of the view / edit child form.
Child Grid View / Edit Bottom Text Static text to be displayed on the bottom of the view /edit child form.
Fields default to read only but can be defined as editable,(e), in the View/Edit Form fields which will automatically change the icon available to the user and present those designated fields as such.
The wrench icon can be selected to choose the view edit fields from the service metadata.
Create / Delete Fields
The following fields define those fields available when create functionality is desired.
Create Form Fields Resource fields that the user will be prompted to populate in order to create a given resource.
Child Grid Create Form Fields Child Resource fields that the user will be prompted to populate in order create a line item for a given resource if applicable.
Enable Create in Parent Grid The following options are available:
Create
This option will create the item in the ERP and redirect the user back to the main portal page.
Create and Continue
This option will create the item in the ERP and redirect the user to the View/Edit Page.
Enable Create in Child Grid
Create
This option will create the line item in the ERP and redirect the user back to the new resource header page.
Create and Continue
This option will create the line item in the ERP and redirect the user to the View/Edit Page.
Create Top Text Static text to be displayed on the top of the create form.
Create Bottom Text Static text to be displayed on the bottom of the create form.
Child Grid Create Top Text Static text to be displayed on the top of the create child form.
Child Grid Create Bottom Text Static text to be displayed on the bottom of the create child form.
Enable Delete in Parent Grid Enables the deletion of service grid header items.
Enable Delete in Child Grid Enables the deletion of service grid child items.
The wrench icon can be selected to choose the create fields from the service metadata.
Submit Fields
The following fields relate to the optional submit functionality.
Submit Field When populated with a Boolean field from the resource a submit icon will be visible on the list view and upon selection by the user the Boolean field will be populated on the resource.
Notification Upon Submit Email address of user(s) to notify upon user selection of submit.
Notification Sender From email address of user for notification email.
Notification Subject Subject of the email notification
*The record related to the “Submit” option has already been created in the ERP. It is the responsibility of the ERP user to leverage the Boolean field on the applicable page for their review.
Restricted Permissions Fields
The following fields relate to the optional restricted permissions functionality.
Restricted Permissions When selected, 3 additional fields become available: Read Only, Edit & Create that can be populated with a SharePoint group.
Read Only Users belonging to a SharePoint group assigned to this option will have read only rights to data for this service.
Edit Users belonging to a SharePoint group assigned to this option will have edit and read rights to data for this service.
Create Users belonging to a SharePoint group assigned to this option will have create, edit and read rights to data for this service.
Field Configuration Syntax
This section is for reference only as the proper syntax is generated by the service configurator. <Field name><[text]><additional attribute>,
Field Name: Name of metadata field as it appears in service.
For Example:
[Text] = Use [ ] to define text shown to user (Not Required)
Additional attributes (Not Required):
(e) = Editable (Applies to view edit fields only)
(h) = Hidden (Applies to create fields only).
{ } = Default the text (Applies to create fields only).
(ta) = Multilinetext box
(w) = Whole Number
(sd) = Date (no time)
(asc) = Ascending (Applies to sort fields only)
(des) = Ascending (Applies to sort fields only)
(hl) = Hyperlink. Turns Field into clickable hyperlink
