You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.
Home > moovs > Basic moov steps: A Quick Reference Guide
Basic moov steps: A Quick Reference Guide
print icon

This guide outlines the steps to configure a moov that processes data after it's received, based on definitions from the File Definition. The example moov will include receiving the file, creating custom fields, filtering data, transforming it, adding header rows, naming the file, importing the file, and sending a notification of successful import.  These steps are designed to help you understand the flow and execution process, making it easier to replicate for your own integrations.

 

moov Steps

 

  1. Trigger: Set up the moov to receive the file based on the File Definition.
  2. Create custom fields: Define and map any custom fields required for your data.
  3. Filter data: Removes rows of a file which meet predefined filter protocols
  4. File Transformation: Transforms the input file into a desired output format.
  5. Add header rows: Insert the necessary headers for proper file structure.
  6. Name File: Assign a name to the file before importing.
  7. Import the file: Applies rules to name the file for external usage (i.e. file receiver naming requirements)
  8. Notification: Configure a notification to confirm the file import was successful.

 

 

Create a new moov Definition

 

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.

 

 

moov Steps outlined in detail 

1. Enter moov Definition Details

In this example, we’ll walk through the basic steps for a time import moov.

 

  • Provide the following:
    • moov Name
    • Integrates with
    • Integration Type
    • Provide moov description

2. Trigger Step (moov step # 1)

  • Select the trigger type:
    • Data Trigger (for File Definition)
    • Document Trigger
    • QBO IIF Trigger

In this example we will use Data Trigger:

  • Select Data Trigger from the dropdown.
  • Enter a description.
  • Choose the File Definition and click OK.

3. Custom Fields Step (Step # 2)

  • Create Custom Fields as needed for counting records, totals, etc.
  • Click +ADD to create custom fields.
    • Enter the Field Name.
    • Choose the field type.
    • Enter a static value if applicable.
  • Click Save Changes.

4. Filter File Step (Step # 3)

  • Add the Filter File step if you are filtering out rows.
  • Select the appropriate filter from the Filter Definition dropdown.
  • Enter a description and click OK.

5. File Transformation Step (Step # 4)

  • Select File Transformation
  • Select the transformation from the Transformation Definition dropdown.
  • Provide a description and click OK.

6. Create Header (Step # 5)

  • Select the Add Header /Foot Rows from the step.
  • Provide a description.
  • Click ADD ROW
  • Select the Type (CSV or Fixed Length) and select the Delimiter (, ; | * tab)
  • Click ADD Component to create the Header Rows

7. Name File Step (Step # 6)

  • Add a Name File step to define the file naming convention (e.g., ClientID_[Date in MMddyyyy].csv).
  • Click Add Step, choose Name File, and click Add Naming Component for each part of the name.
  • Click Save Changes.

8. Importing or Sending the File Step (Step # 7)

  • Select the step to import or send the file:
    • FTPS Transfer
    • Send File Via Email
    • SFTP Transfer
    • Import to iSolved, UKG, PrismHR or the platform you are using
  • In this example we are using iSolved, select the isolved import.
  • Provide a description.
  • Click OK

9. Send Notification (Step # 8)

  • Select Notification from the Step
  • Provide a description.
  • Enter the email address and reply to email addresses 
  • Provide a Subject
  • Enter the body of the email.  This is where you can add the custom fields you created in step 2.

10. Publish the Moov Definition

  • After adding all steps, click Save Changes.
  • To publish the Moov, edit the definition and click Publish in the top-right corner.

 

 

Your moov definition is now available in the moovs section for client configuration.

 

Important Note on moov Steps:

 

The steps shown are a basic example of configuring a moov. Depending on the complexity of your moov, it may include multiple transformations or queueing additional moovs for further processing.

 

This example serves as a guide but is not limited to these specific steps. Your moov may require more or fewer steps, tailored to the needs of your integration. Adjustments can be made to handle more complex moov or additional processing requirements.

 

 

Refer to the following articles for additional help:

 

 

scroll to top icon