Snap type: | Read | ||||||
---|---|---|---|---|---|---|---|
Description: | A Snap that searches records from Dynamics AX instance using identifiers such as Company, Object Type, and so on based on specified search queries. ETL Transformations & Data FlowThis Snap enables the following ETL operations/flows: Search and extract records from an Dynamics AX instance with conditions in the Snap configuration as well as input documents, and feed the records to the downstream Snaps. Input & Output
Modes
| ||||||
Prerequisites: |
| ||||||
Limitations and Known Issues | To read a large data sets, you can first get all the keys of records with Fetch keys only property enabled on the Snap settings, and loop through the keys. Use the JSON Splitter Snap to get the list of the keys and then read the actual records with Read Snap. | ||||||
Configurations: | Account & AccessThis Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Microsoft Dynamics AX Accounts for information on setting up this type of account. Views
| ||||||
Troubleshooting: | None at the moment. | ||||||
Settings | |||||||
Label | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | ||||||
Company | The company name to perform search operation on. The company should be defined on the AX instance side. The property can be provided through user input or pipeline parameters. Example: Snaplogic Default value: [None] | ||||||
AIF endpoint | Required. URI of the inbound port. You may find the information at the Dynamics AX instance: System administration > Setup > Services and Application Integration Framework > Inbound ports > [Your port name] > URI. Example: Default value: [None] | ||||||
Object type | Required. The object type to perform search on. The value of the property depends on the object types contained in the target inbound port. Example: Customer Default value: [None] | ||||||
Fetch keys only | If enabled, only key of the searched record will be returned. Default value: Not selected | ||||||
Dynamics AX Query Table | The table defines zero or more query criterias. If no criteria is given, the Snap would fetch all of the records available. For multiple criterias with same Query field, they will be connected by "OR". For multiple criterias with different Query field, they will be connected by "AND". | ||||||
Data source | The name of the Dynamics AX datasource to query. e.g. to query for Customers data type, we should enter CustTable. For the table references, refer to C Tables. Example: CustTable Default value: [None] | ||||||
Query field | Field that the search condition is related to. The field should belong to the datasource above. For the fields, refer to C Tables . Example: AccountNum (For table CustTable) Default value: [None] | ||||||
Query operator | Query operator for the search condition.
Example: Equal Default value: LesserOrEqual | ||||||
Value/Lower bound | Criteria to use when evaluating which records to return. Lower bound is applicable for Range operator and will act as a inclusive lower bound. The property accept expressions, and can be set from input Document as well as Pipeline parameters. The property is reflecting "Value 1" in AIF Query Criteria. Example: BRMF-000001 Default value: [None] | ||||||
Upper bound | The inclusive upper bound for Range operator. The value will only be picked up only when Query operator is set to Range. The property accept expressions, and can be set from input Document as well as Pipeline parameters. Example: BRMF-000004 Default value: [None] |
Basic Use Case
Typical Snap Configurations
Key configuration of the Snap lies in how the values are passed. The values can be passed:
- Without Expressions
Values are passed directly into the Snap.
- With Expressions
- Using Pipeline parameters: Values are passed as Pipeline parameters (parameters to be applied can be selected by enabling the checkbox under the Capture column)
Advanced Use Case
The following describes a pipeline, with a broader business logic involving multiple ETL transformations, that shows how typically in an enterprise environment, Create, Read, Search and Delete functionalities can be used. Pipeline download link below.
This pipeline moves records from a Salesforce instance to the Dynamics AX instance, where the records are created, searched and read for the required IDs and deleted them as needed.
The ETL Transformations:
- Extract: The Salesforce Read Snap retrieves the records from an object type from the Salesforce instance
- Transform: The Mapper Snap maps the records from the Salesforce object to the Dynamics AX instance
- Load:The Dynamics AX Create Snap creates the records on the AX instance
The pipeline further uses:
- The Mapper Snap maps the records to be searched from an Object type.
- The Dynamics AX Search Snap searches all the records.
- The JSON Splitter Snap splits the the records based upon the field names.
- The Dynamics AX Read Snap reads the records based on the given fields and they are retrieved from the bottom using the Tail Snap.
- The Mapper Snap maps the records to be deleted using the Dynamics AX Delete Snap.
Exported pipeline is available in the Downloads section.
Downloads