A moov Definition is a set of defined steps that "moovs" data after it has been received, using the definitions created from the File Definition. The File Definition is the foundation of the moov Definition. If you are creating a custom moov and haven't already created a File Definition, please refer to the How to create a new File Definition article.
For the example below, we will create a moov that:
- Receives the source file defined in our File Definition
- Filters the data to remove unwanted records
- Transforms the data
- Names the File
To create a new moov definition, access the Admin Console by clicking on your initials at the top right hand corner.
Next you will want to click on moov Definitions tab, and then click the Add button to create a new moov definition.
If you do not see the moov Definitions option in the Admin Console, please Contact Us to request the feature to be added to your account.
Enter in a Name, an Integrates with, Integration Type, and moov description.
We can now create our moov definition based on how we want to process our data.
The first step in a moov Definition is the trigger step which defines the type of data that will be received. The basic trigger steps are:
- Data Trigger - data is based on a File Definition
- Document Trigger - a document is received
- QBO IIF Trigger - an .IIF file is received to import to QuickBooks Online
To add a step to the moov definition, click the Add Step button.
In our example, we will be creating a moov Definition with a Data Trigger related to a File Definition.
To create a Data Trigger moov, select this option from the Steps dropdown, enter in a Description, select a File Definition, and click OK.
If you do not see a specific File Definition you have created, please refer to the How to create a new File Definition article and make sure the definition has been published.
The next step we will be adding is the Filter File step. This will allow us to select a Filter Definition based on the File Definition we selected in the Trigger step above.
To add the step, click the Add Step button, select the Filter File option from the Step dropdown menu, provide a Description and select a filter from the Filter Definition dropdown then click OK.
If you do not see a specific Filter Definition you have created, please refer to the How to create a new Filter Definition article and make sure the definition has been published.
Now we will add the transform step to transform the data to our created transformation definition.
To add the step, click the Add Step button, select the File Transformation option from the Step dropdown menu, provide a Description and select a transformation from the Transformation Definition dropdown then click OK.
Next, we will add a Name File step that renames our file into a specific naming convention we create.
For our example, we will name the file using the following naming convention: [Date in yyyymmdd]_401k.csv
To add the step, click the Add Step button, select the Name File option from the Step dropdown menu, provide a Description and the click the "Add Naming Component" button.
For each of our naming components, we would add a new component and specify the values for each component, then click OK
Now that we have added the necessary steps to our moov definition, click Save Changes.
In order for a moov Definition to become available in the moovs section of your account, it must be published. To Publish the moov Definition, edit the definition and click on the Publish button at the top right hand corner of the page.
Your moov definition is now available in the moovs section of your account. Click the moovs option on the left-hand side and click the moov to configure your client.
