Extraction Configuration

Overview

The Extracts screen allows you to add new extract configurations and run them, as well as view details of already prepared extract configurations so that you can verify them and edit if needed.

Extracts Screen

The Extracts screen comprises of the following elements:

  • The Add button - click it to create a new extract configuration
  • The Refresh button - click it to update information about an extract configuration
  • The grid - use it to see a list of all defined extract configurations. The grid has the following columns:
    • Extract name - the name of the extract configuration
    • Data source - the type of data that will be extracted, for example, Journals
    • Status - the configuration status:
      • Draft - when a configuration of a particular extract is saved as a draft but not yet submitted
      • Inactive - when a configuration of a particular extract is submitted but a current date is earlier than the start date or the current date is past the end date

        Note that you will not be able to run an extract configuration that has the Inactive status and the current date is past this configuration end date. The Run now button will not be available.

      • Active - when a configuration of a particular extract is submitted and a current date equals a start date or is past it (and the current date is earlier than an end date if the end date is defined)
    • Start date - the date and time when the configuration starts to be active
    • End date - the last date and time when the configuration has the Active status
    • Created by - the username of a user who saved and submitted the configuration
    • Created on - the date and time when the configuration was created
    • File type - the type of an exported file, for example, CSV
    • Target name - the name of cloud storage to which an extract file will be uploaded. If the extract file is triggered via REST API, its data is presented in your API tool.

Additionally, you can:

  • Click a particular row to go to the view mode screen of the selected extract configuration. To go back to the Extracts screen, click the X button.
  • Sort columns ascending or descending and set their visibility by clicking the three dot icon next to the names of columns
  • Filter content within each column to find particular information

Edit Extraction Configuration Screen

This screen is displayed if you click an extract configuration that you want to edit. The screen comprises of the following elements:

  • The list of already created extract configurations. You can click an extract configuration name to view its details and perform the required actions. To go back to the Extracts screen, click the X button.
  • The action buttons:
    • The Edit button - click it to edit an already saved extract configuration. Depending on the extract configuration status you will be able to edit:
      • All of the settings within this configuration if the extract configuration has the Draft status
      • A start date and time and an end date and time in the Effective dates section and a description if the extract configuration has the Inactive status and it has not been started yet (the current date is earlier than the start date for this extract configuration)

        You cannot edit the extract configuration which already ended (i.e. a current date is later than the dates defined in the Effective dates section).

      • An extract configuration description as well as an end date and time (in the Effective dates section) if the extract configuration has the Active status
    • The Clone button - click it to clone a selected extract configuration
    • The Convert to REST button - this button is available only for extract configurations with the disabled scheduler. Click the button to change the target type from cloud storage to REST API for a selected extract configuration. The conversion will allow you to trigger this extract configuration exclusively via REST API. Consequently, you will not be able to:
      • Trigger this extract configuration via Fynapse GUI
      • Configure the scheduler
      • Rerun this extract configuration (using the Extraction Logs screen)
      • Download the extract file from GUI (using the Extraction Logs screen even if this functionality is enabled on your Fynapse instance)

        Conversion cannot be reverted.

      Additionally, after conversion is completed, some changes will be visible on the Extraction Logs screen for all previous runs of the converted extract configuration. That is, the target space will be changed to REST API and some actions, such as reruning or downloading the extract file, will not be available.
    • The Run now button - click it to run a submitted extract configuration to extract data at a current time. Please do not click the button several times at the same time since it is not recommended to run the same extract configuration in parallel.

      Note that you will not be able to run an extract configuration that has the Inactive status and the current date is past this configuration end date. The Run now button will not be available.

      Note that you will not be able to run an extract configuration for which you select the REST API from the Target name list (the Run now button will not be available). Data from this type of extract configuration can only be extracted via REST API.

    • The Delete button - click it to delete an extract configuration. This button is available only for the extract configuration that has:
      • The Draft status
      • The Inactive status (the current date is later than the end date of this configuration)

New Extraction Configuration Screen

This screen is displayed when you click the Add button on the Extracts screen. It allows you to define a new extract configuration. The screen comprises of the following elements:

  • The list of already created extract configurations
  • The action buttons:
    • The Save draft button - click it to save the extract configuration you are currently working on without submitting it. Such extract configuration will have the Draft status and will be visible only to you.
    • The Submit extract button - click it to save and submit an extract configuration in Fynapse. After clicking this button other users will be able to see your extract configuration. You will not be able to delete it and the editing options will be limited.

      Only extract configurations that have the Inactive status (the current date is later than the end date of this configuration) can be deleted.

  • The Cancel button - click it to discard an extract configuration. The process of defining the extract configuration will be cancelled and unsaved changes will be lost.
  • The Run now button - click it to run a submitted extract configuration to extract data at a current time. The button is available for a new extract configuration after clicking the Submit extract button but it is not available for the extract configuration that has the Inactive status and the current date is past this configuration end date.

The extract configuration can be divided into three panels:

  • Information - this panel comprises all basic settings of the configuration such as:
    • Destination - settings defining the extract configuration. They vary depending on the selected target name.
      • Target name - an upload space where extracted data will be placed, for example, cloud storage.

        If you select REST API from the Target name list, then you will be able to extract data for this extract configuration only using REST API. What is more, you will not be able to run this extract configuration manually using Fynapse GUI or configure the scheduler. You do not have to select the file type.

      • File type - a file format that will be used for extracted data, for example, CSV. The field is available when the Cloud storage is selected from the Target name list.

        The Namespace and Entity name fields are available when FDS is selected from the Target name list.

      • Namespace - a logical set to which an Entity belongs, by default, it is called fynapse
      • Entity name - a list that displays descriptions or names of user-defined Entities to which you want to extract data for further processing in Flows.
        These can be:
        • Reference Entities defined in FDS - such Entity must have the same data structure as the Entity from which you extract data.
        • Transaction Entities - such Entity must have the same data structure as the Entity from which you extract data.

          When defining an Entity remember to add extractId. For more details, refer to Flows.

        • Transient Entities - Entities created by the extract which inherit the structure and temporalityType of the source Entity selected in the Data source field. These Entities are created exclusively for use as input for Flows. They are visible in the grid on the Finance Data Service screen, if they inherit the Reference, but the data contained in them cannot be browsed when you open the Entity details screen, because it is not stored in Finance Data Service until it has been transformed into an FDS Entity by a Flow. They are downloaded in the Configuration Data JSON file and can be reuploaded.

          It is possible to define validations and enrichment for transient Entities by downloading the Configuration Data JSON file, adding the validations and enrichment and then reuploading the file.
          Remember that the added validations and enrichment have to be compatible with the existing data model.

          If you want to use this mechanism as input for Flow, please remember not to run the extract until you have defined the Flow. If you run the extract before the Flow is up and running, the data that would be exported to the Entity before the Flow is ready will not be processed.
          This is especially important if you want to use the scheduler feature. Remember to schedule the date for the first extract after you know the Flow will be ready.

      • At the top of the list, you can find an option that allows you to create a transient Entity:
        • Create new - if you click this, you can create the transient Entity. If you create a transient Entity from a Reference Entity it will be visible on the Finance Data Service screen
          • New Entity name - a name of the Entity you are about to create with this extract configuration
  • Data definition - this panel allows you to define further details of the extract configuration, create a new query for data extraction based on selected sets of attributes, or select the query saved on the Balances screen (for Balances). This panel comprises of:
    • Details - this panel allows you to select what type of data you want to extract and configure additional options:
      • Namespace - a logical set to which data source belongs, by default it is called fynapse
      • Data source - the type of data that will be extracted, for example, Journals
      • Entity name - a list that displays descriptions or names of user-defined Entities that you want to extract. It is available if you select FDS from the Data source list.

        If you set the target name to FDS you need to select the Entity that has the same data structure as the Entity you selected in the Destination panel from the Entity name list.

    • The Extract only incremental data checkbox - if it is selected only data that was not previously extracted using the same extract configuration will be extracted. To find out how it works, refer to the Types of Data Extraction section.

      For extracts to FDS Entities, the Extract only incremental data is always set by default to avoid exponential increase of extracted data, as only increments are extracted after initial extract to avoid duplication of records. It is set by default for all extracts apart from Balances.

    • The Split per Posting Date checkbox - available only for Journals and Unposted Journals. This option is unavailable for REST API extract configurations. If it is selected, then extracted data will be split into separate files according to the Posting Date attribute. The system automatically identifies the Posting Dates so you do not have to configure anything. One extract file contains data from one Posting Date unless there are some records that were not included in an extraction process for their Posting Date. In such a situation, the extract file will contain data from more than one Posting Date. To learn more, refer to the Splitting Data into Separate Extract Files by Posting Date section.
    • Query criteria - for Journals, Errors, Unposted Journals, and user-defined Entities the panel has the following options:
      • The Set query attributes to extract only selected data checkbox - select this checkbox to enable the Attributes list and narrow down data that will be extracted
      • The Attributes list - the list is enabled after selecting the Set query attributes to extract only selected data checkbox. Use it to select the attributes that you want to use to define a query.

        If you do not select any criteria, then all data will be extracted.

      • The Add button - click it to add conditions
      • The Match any button - click it if one of the defined conditions has to be met
      • The Match all button - click it if all defined conditions have to be met
    • The Journal Aggregation panel contains the following options:
    • Create Journal Aggregation - select it to define a standard aggregation of Journals based on Dimension Sets. This option is available only when you select Journal or Unposted Journal as a data source. The following options are available:
      • Dimension Set - a list displays all available Dimension Sets. You need to select one Dimension Set to use it to aggregate data. If the list is empty, you will not be able to configure the Journals aggregation because at least one Dimension Set must be configured in Fynapse (in Configuration > Accounting Configuration > Dimension Sets). To learn more about Dimension Sets, refer to the Dimension Sets chapter.
      • Dimensions - a preview of the selected Dimension Set in read-only mode that allows you to see its details
      • Exclude Dimensions from extract (optional) - a list displays all user-defined Dimensions that you can select to exclude from the extract. They will not be taken into consideration while aggregating data.
      • Measures - displays a list of fields (only amount field types) that will be summed to create the aggregation
    • Create Advanced Journal Aggregation - select it to define advanced aggregation not based on Dimension Sets. This option is available only when FDS is selected as a target name and Journal or Unposted Journal as a data source. The following options are available:
      • The Group & order Attributes list - a list displays all available attributes that you can select to create the aggregation. Once you select the needed attributes, you can order them in the way you want data to be sorted and displayed by dragging attributes.
      • The Partitioning Attributes list - a list displays attributes that you can select to group Journal Lines into independent data sets.
    • Query criteria - for Balances the panel has the following options:
      • Saved criteria - the list displays all query criteria saved on the Balances screen. You need to select one query to use it to extract a particular set of data. If the list is empty, then you need to go to Subledger > Balances to configure and save the query criteria.
      • Preview of the selected saved criteria in the read-only mode that allows you to see details of the selected Balances query
      • Attribute based filtering – this panel allows you to configure which reference data attributes will be used to filter selected Balances. The panel comprises:
        • The Dynamic filtering (attribute based) checkbox – select this checkbox to enable filtering reference data from the Entity selected from the Criteria source reference Entity list.
        • The Criteria source reference Entity list - a list that displays Entities which reference data can be used to filter Balances
        • Attribute matching - an option that allows matching reference Entity attributes to the proper Balance attributes. You can add more than one matching pair by clicking the Add button.
          • The first list displays attributes available in the reference Entity
          • The Balance list displays attributes available in the selected Balances
        • The Only extract Balances with changed reference data toggle switch - enable this option if you want to extract only Balances for which reference data has changed since the previous extraction run.
        • Additional filters - this section allows you to define additional reference data filters that will narrow down the extracted Balances. It includes the following:
          • The Set query attributes to extract only selected data checkbox - select this checkbox to enable the Attributes list that will allow you to apply more reference data filters on extracted Balances.
          • The Attributes list - the list is enabled after selecting the Set query attributes to extract only selected data checkbox. Use it to select the attributes from the reference Entity (selected from the Criteria source reference Entity list) that you want to use to define additional filters. Once you select the attribute, you need to define at least one condition.
          • The Add button - click it to add more conditions
          • The Match any button - click it if one of the defined conditions has to be met
          • The Match all button - click it if all defined conditions have to be met
  • Scheduler - this panel allows you to configure an exact date and time as well as frequency when a particular extract configuration should be run. This panel comprises:
    • Scheduler type - use this section to decide if your configuration will be run on specific dates or on a basis of a defined frequency
      • Disabled - if you choose this option, then you do not need to configure the scheduler and you will have to run your extract configuration manually, that is by clicking the Run now button or using REST API endpoint.

        To enable a previously disabled scheduler for a particular extract configuration, this extract configuration must have the Draft status.

      • Specific dates - if you choose this option, then you need to define at least one date and time and this date must be included within the Effective dates (you will not be able to choose from the calendar not included dates). To add another specific date (it denotes another repetition of the data extraction), click the Add button. Note that each specific date can be used only once. To delete the specific date, click the trash bin icon. To see some examples, refer to the Types of Data Extraction section.
      • Frequency - if you choose this option, then you need to define at least one configuration in Primary frequency. This panel comprises of:
        • Primary frequency:
          • The Repeat list - use it to select how often the extract configuration must be triggered. You can select a particular option only once.
          • Time settings - use it to set when exactly the extract configuration must be triggered. The type of time setting depends on the option you select from the Repeat list. To learn more about time settings, refer to the Time Zone Support in the Scheduler section. The below options are available for a particular repetition:
            • Per hour - 1 minute, 5 minutes, 10 minutes, 15 minutes, 30 minutes, and 60 minutes
            • Daily - an hour and minutes (AM/PM)
            • Weekly - a day (for example, Monday) and an hour and minutes (AM/PM)
            • Monthly - a day (for example, 4 that is always on the fourth day of the month) and an hour and minutes (AM/PM)
            • Yearly - a month (a name of the month), a day (for example, 4 that is always on the fourth day of the month), and an hour and minutes (AM/PM)
          • The Add button - click it to add another time setting (it denotes another repetition of the data extraction within a given frequency)
          • The trash bin icon - click it to delete a particular setting row
        • Additional frequency - contains the same settings as the Primary frequency panel. You can select a particular option only once. To delete a particular setting row, click the trash bin icon.
        • The Add additional frequency button - use it to add another frequency setting
        • The trash bin icon - click it to delete a particular additional frequency

Dynamic Date Attributes Filtering

Dynamic date filtering is available for date attributes in the following data sources:

  • Journals
  • Unposted Journal
  • FDS

It allows you to decide from which date range, calculated dynamically backwards on the basis of a defined relative date, you want to extract data. The system calculates those date ranges dynamically each time the extraction process is initiated.

For example, if the dynamic filter is set to 11 days and the ending anchor is set to the previous day. Fynapse will extract data for the following date ranges:

  • 15.12.2025-25.12.2025 (inclusive) when the extraction is executed on 26.12.2025
  • 15.01.2026-25.01.2026 (inclusive) when the extraction is executed on 26.01.2026

In each case, Fynapse recalculates the dates dynamically to ensure that the most recent 11 days of data is included.

The option is available in the Query criteria panel after selecting the date attribute from the Attributes list and selecting the Dynamic option from the drop-down.

The Dynamic option can be selected only once for a particular date attribute. However, the query criteria can contain more than one date attribute.

  • The Period types list:
    • Years
    • Months
    • Days

The Number of years/months or days list - displays a number of years/months or days for which the data extraction will be performed

You can extract data only for a maximum of 12 years.

  • The Ending anchor list - specifies the point in time that sets the end date for data extraction. Data available for this end date is included in the extraction. Depending on the selected period type (years, months or days) a different list of ending anchors is available:
    • Current date - the actual date on which the extract configuration is run, i.e., the current Business Date
    • Previous day - the date on the day before the current date, determined based on the Business Date
    • Previous period end - selecting this ending anchor for years and months requires selecting the Fiscal Calendar to determine the period end.
    • Previous year end - selecting this ending anchor for years requires selecting the Fiscal Calendar to determine the year end. Data will be extracted for a defined number of years until the previous year end
  • The Fiscal calendar list - displays the Fiscal Calendars used in the system, on which basis the period end or year end will be defined.

    To ensure successful extraction, check whether the Fiscal Calendar you want to use has all periods defined and the calendar for a selected year exists in Fynapse.

    If the selected Fiscal Calendar does not have defined periods or the calendar for a selected year is not configured, then an error is thrown and the extraction process fails. The error message is displayed in the Error message column on the Extraction Logs screen. Once you correct the calendar, the extraction process will be rerun automatically.

If you set the scheduler type to Frequency, then after configuring it, you will see an information box listing the date when the first extract will be run and a date range for which data will be extracted. Such information will be specified for each date attribute that has the dynamic filtering configured.

Dynamic Date Filtering Examples

The tables below provide examples that illustrate how dynamic date filtering works.

The first table lists examples for the period type set to Days.

Current User UTC TimezoneUTC+1UTC+1UTC+1UTC+1UTC-5
Next Extraction in User Timezone10.02.2026 12:00 AM10.02.2026 2:00 AM30.03.2026 12:00 AM31.03.2026 12:00 AM30.03.2026 12:00 AM
Next Extraction in UTC+00:0009.02.2026 23:00 PM10.02.2026 1:00 AM29.03.2026 23:00 PM30.03.2026 10:00 PM30.03.2026 05:00 AM
Ending AnchorPrevious DayPrevious DayCurrent DayPrevious DayCurrent Day
Period TypeDaysDaysDaysDaysDays
Number of Periods3330530
Calculated Period Start and End06.02.2026-08.02.202607.02.2026-09.02.202628.02.2026-29.03.202625.03.2026-29.03.20261.03.2026-30.03.2026
CommentNote how the selected extraction time and user timezone impact the calculated date criteria.Note how the selected extraction time and user timezone impact the calculated date criteria.Note that the timezone impacts the calculated date. Also, the start date is adjusted as 29.02 is not a valid date.Note that on 31.03 the user’s timezone will be UTC+2 (summer time switch from 29.03.2026), hence the calculated UTC+00:00 extract date is 10:00 PM on the previous dayNote that the timezone impacts the calculated date.

The second table lists examples for the period type set to Months.

Current User UTC TimezoneUTC+1UTC+1UTC+1
Next Extraction in User Timezone10.02.2026 12:00 AM10.02.2026 12:00 AM29.03.2026 12:00 AM
Next Extraction in UTC+00:0009.02.2026 23:00 PM09.02.2026 23:00 PM28.03.2026 11:00 PM
Ending AnchorPrevious Period EndPrevious Period EndCurrent Day
Period TypeMonthsMonthsMonths
Number of Periods121
Fiscal CalendarGregorianCustom-
Calculated Period Start and End1.01.2026-31.01.20261.10.2025-30.11.202501.03.2026-28.03.2026
Comment-According to the custom calendar, the previous period ends on 30.11.2025. The subtracted months are adjusted so the start date is the first day of the month.Note that on 29.03 the user is still in UTC+1 (summer time switch from 29.03.2026), hence the calculated UTC+00:00 extract date is 11:00 PM on the previous day.

The third table lists examples for the period type set to Years.

Current User UTC TimezoneUTC+1UTC+1
Next Extraction in User Timezone10.02.2026 12:00 AM10.02.2026 12:00 AM
Next Extraction in UTC+00:0009.02.2026 23:00 PM09.02.2026 23:00 PM
Ending AnchorPrevious Year EndPrevious Year End
Period TypeYearsYears
Number of Periods11
Fiscal CalendarGregorianCustom
Calculated Period Start and End1.01.2025-31.12.20251.12.2024-30.11.2025
CommentAccording to the Gregorian calendar, the previous year ends on 31.12.2025.According to the custom calendar, the previous year ends on 30.11.2025.

Tutorials

This tutorial is dedicated to the following data sources: Journal, UnpostedJournal, Error, and user-defined Entities. For Balances refer to the How to Add an Extract Configuration for Balances? tutorial.

  1. Go to Configuration > Extracts.
  2. Click the Add button.
  3. Provide basic information about your extract configuration:
    1. Type a name (we recommend keeping the names of extract configurations unique across the system) and optionally a description.

      While typing the name of an extract configuration, you can use upper-case and lower-case letters, digits, spaces, periods, exclamation marks, parentheses, hyphens, and underscore characters. We do not recommend using other special characters because it can cause problems while sending and downloading extract files.

    2. Configure the dates and time during which your extract configuration will be active by defining the Effective dates. You need to provide a start date and time. To configure an end date and time, click the Set End date and End time checkbox.
    3. Select a target name and a file type.
  4. Define data details:
    1. From the Namespace list, select fynapse.
    2. From the Data source list, select the data source.
    3. If you selected FDS as the data source in the previous step, now from the Entity name list, select an Entity that you want to extract.

      At this point, you can save your configuration as a draft by clicking the Save draft button. If you saved your work then to continue configuring you need to click the Edit button.

    4. Select the Extract only incremental data checkbox if you want to extract data that was not extracted in the previous run of this extract configuration.
    5. Select the Split per Posting Date checkbox if you want to split data into separate files according to the Posting Date attribute. Note that Fynapse automatically identifies the Posting Dates so you do not have to configure anything.
  5. Select the Set query attributes to extract only selected data checkbox to configure a query to determine which data will be extracted:
    1. To filter by certain attributes click the Attributes field to see a list of attributes. To select a particular attribute click it.

      If you do not select any criteria, then all data will be extracted.

    2. You must define filters for previously selected attributes by adding operators and configuring their values. To add another operator to the selected attribute, click the Add button.
    3. If you select a date attribute and set an operator to Dynamic, then you need to:
      1. From the list, select the period type, for example, Days.
      2. Define a number of days, months or years for which you want to extract data.
      3. From the Ending anchor list, select the point in time that sets the last day from which data will be extracted.
      4. If you select the Previous period end or Previous year end option from the Ending anchor list, then from the Fiscal calendar list, select the valid calendar.

      To ensure successful extraction, check whether the Fiscal Calendar you want to use has all periods defined and the calendar for a selected year exists in Fynapse. If the selected Fiscal Calendar does not have defined periods or the calendar for the selected year is not configured, then an error is thrown, and the extraction process fails. The error message is displayed in the Error message column on the Extraction Logs screen. Once you correct the calendar, the extraction process will be rerun automatically.

  6. Select the Create Journal Aggregation option to configure an aggregation based on Dimension Sets. Define the aggregation:
    1. From the Dimension Set list, select a Dimension Set on which basis you want to aggregate data.

      If the list is empty, you will not be able to configure the aggregation. The Dimension Set must be configured first in Fynapse.

      Once you select the Dimension Set, its preview will be displayed in the Dimensions field, and the Measures field will display a list of fields (only amount field types) that will be summed to create the aggregation.
    2. From the Exclude dimensions from extract (optional) list, select Dimensions that you do not want to utilize for the aggregation. The list displays only user-defined Dimensions.

      If you want to create an advanced aggregation, refer to the Create Advanced Journal Aggregation description.

  7. Configure a scheduler to extract data at a defined time by selecting on which base it will be run:
    1. If you select the Specific dates option, then by clicking the Add button add as many dates as you need. The number of configured dates denotes how many times data will be extracted. Note that each specific date must be unique, for example, you cannot add this setting 25.07.2023 at 11:00AM more than once. Additionally, defined dates must be included within the effective dates (defined in step 3b).

      If you do not want to use the scheduler and run the extract configuration manually, select the Disabled option. Keep in mind that to enable a previously disabled scheduler for a particular extract configuration, this extract configuration must have the Draft status.

    2. If you select the Frequency option:
      1. You need to define at least one configuration in the Primary frequency panel by selecting an option from the Repeat list and configuring its details. Click the Add button to add more settings. To learn more about time settings, refer to the Time Zone Support in the Scheduler section.
      2. If you need more than one frequency, click the Add additional frequency button and configure it in the same way as you did while defining the primary one. Note that each frequency setting must be unique within one frequency base, for example, you cannot add this setting Wednesdays at 11:00AM more than once.

        If the same schedule time is introduced more than once within one extract configuration, then Fynapse schedules this extract configuration only once for this time.

  8. If you finished creating your extract configuration, you can now publish it by clicking the Submit extract button.

    Note that after submitting the extract configuration, you will only be able to edit some of its settings and other users will be able to see this configuration.

  9. Confirm your action.
  10. To start the extraction process on the basis of the newly created extract configuration, click the Run now button. The extraction process will start and:
    1. All data available in the system up to the moment you clicked the Run now button will be extracted if you selected the Extract only incremental data checkbox.
    2. Only data that was not extracted in the previous run of this extract will be extracted (note that during the first run of this extract configuration, all data will be extracted) if you selected the Extract only incremental data checkbox.
    3. Data will be split into separate extract files according to the Posting Date attribute if you selected the Split per Posting Date checkbox.
    4. You will see a proper extraction log in the Extraction Logs grid and the extract file will be placed on the defined cloud storage.
    5. If the data source is Journal or Unposted Journal, then Fynapse will automatically generate a manifest receipt file for the dedicated extract file and will place it on the cloud storage under the same path as the extract file. To find out more, read the Manifest Receipt File section.
    6. If the data source is Journal and you use the aggregation option, you will be able to see the Open journal link in the Journals column in the Extraction Logs grid. Once you click the link, you will be redirected to the Journals screen in Subledger to view all Journals that were included in the aggregation in the selected extract file.
  1. Go to Configuration > Extracts.
  2. In the grid find an extract configuration that you want to run now.
  3. Click this extract configuration row. You will be redirected to its view mode.

    If you select the extract configuration that has the Draft status you need to click the Submit extract button first to be able to click the Run now button in the next step.

    Note that you will not be able to run an extract configuration that has the Inactive status and the current date is past this configuration end date. The Run now button will not be available.

  4. Click the Run now button. The extraction process will start and:
    1. All data available in the system up to the moment you clicked the Run now button will be extracted if you selected the Extract only incremental data checkbox.
    2. Only data that was not extracted in the previous run of this extract will be extracted (note that during the first run of this extract configuration, all data will be extracted) if you selected the Extract only incremental data checkbox.
    3. Data will be split into separate extract files according to the Posting Date attribute if you selected the Split per Posting Date checkbox.
    4. You will see a proper extraction log in the Extraction Logs grid and the extract file will be placed on the defined cloud storage.
    5. If the data source is Journal or Unposted Journal, then Fynapse will automatically generate a manifest receipt file for the dedicated extract file and will place it on the cloud storage under the same path as the extract file. To find out more, read the Manifest Receipt File section.
  5. To go back to the Extracts screen, click the X button.
  1. Go to Configuration > Extracts.
  2. In the grid find an extract configuration that you want to edit.
  3. Click this extract configuration row. You will be redirected to its view mode.
  4. Click the Edit button. You can edit:
    1. All of the settings within this extract configuration if it has the Draft status
    2. A start date and time and an end date and time in the Effective dates section, a description and the Exclude dimensions from extract (optional) list if the extract configuration has the Inactive status and it has not been started yet (the current date is earlier than the start date for this extract configuration)
    3. An extract configuration description, end date and time (in the Effective dates section) as well as the Exclude dimensions from extract (optional) list if the extract configuration has the Active status
  5. Click the Save draft button or the Submit extract button to save the edited extract configuration or the Cancel button to discard your changes.
  6. To go back to the Extracts screen, click the X button.
  1. Go to Configuration > Extracts.
  2. In the grid find an extract configuration that you want to copy.
  3. Click this extract configuration row. You will be redirected to its view mode.
  4. Click the Clone button. The configuration will be cloned with all the settings but under a new name.
  5. Introduce any changes that you need.
  6. Click the Save draft button or the Submit extract button.

    If you save the extract configuration as a draft, then it will be visible only to you. However, if you submit it, you will have a limited possibility to edit it further, and you will be able to delete it only if its end date is later than the current date.

  7. To go back to the Extracts screen, click the X button.

You can delete an extract configuration only if it has the Draft status or the Inactive status (the current date is later than the end date of this configuration).

  1. Go to Configuration > Extracts.
  2. In the grid find an extract configuration that you want to delete.
  3. Click this extract configuration row. You will be redirected to its view mode.
  4. Click the Delete button.
  5. Confirm your action. The extract configuration will be deleted from the list.
  6. To go back to the Extracts screen, click the X button.
  1. Go to Configuration > Extracts.
  2. Click the Add button.
  3. Provide basic information about your extract configuration:
    1. Type a name (we recommend keeping the names of extract configurations unique across the system) and optionally a description.

      While typing the name of an extract configuration, you can use upper-case and lower-case letters, digits, spaces, periods, exclamation marks, parentheses, hyphens, and underscore characters. We do not recommend using other special characters because it can cause problems while sending and downloading extract files.

    2. Configure the dates and time during which your extract configuration will be active by defining the Effective dates. You need to provide a start date and time. To configure an end date and time, click the Set End date and End time checkbox.
    3. From the Target name list, select FDS.
    4. From the Namespace list, select a namespace.
    5. From the Entity name list, select an Entity to which you want to extract data.

      The Entity to which you want to extract data must have the same data structure as the Entity from which you extract data.

    6. If you want to create a new Entity:
      1. Expand the Entity name list and click Create new.
      2. Into the New Entity name field, type the name of the Entity. Keep in mind that you are creating the transient Entity. This means that it can only be used by custom processing defined in Flows. It inherits the structure of an Entity selected from the Data source field.
  4. Define data details:
    1. From the Namespace list, select fynapse.
    2. From the Data source list, select the data source from which you want to extract data.
    3. If you selected FDS as the data source in the previous step, now from the Entity name list, select an Entity that you want to extract.

      At this point, you can save your configuration as a draft by clicking the Save draft button. If you saved your work then to continue configuring, you need to click the Edit button.

      Note that the Extract only incremental data checkbox is enabled by default if you set FDS as the target source, to avoid an exponential increase of extracted data, as only increments are extracted after the initial extract to avoid duplication of records. It is set by default for all extracts apart from Balances.

  5. Select the Set query attributes to extract only selected data checkbox to configure a query to determine which data will be extracted:
    1. To filter by certain attributes click the Attributes field to see a list of attributes. To select a particular attribute click it.

      If you do not select any criteria, then all data will be extracted.

    2. You must define filters for previously selected attributes by adding operators and configuring their values. To add another operator to the selected attribute, click the Add button.
  6. If you want to configure an aggregation for Journals and Unposted Journals, please refer for more details to step 6 in the How to Add an Extract Configuration tutorial?
  7. Configure a scheduler to extract data at a defined time by selecting on which base it will be run:
    1. If you select the Specific dates option, then by clicking the Add button add as many dates as you need. The number of configured dates denotes how many times data will be extracted. Note that each specific date must be unique, for example, you cannot add this setting 25.07.2023 at 11:00 AM more than once. Additionally, defined dates must be included within the effective dates (defined in step 3b).

      If you do not want to use the scheduler and run the extract configuration manually, select the Disabled option. Keep in mind that to enable a previously disabled scheduler for a particular extract configuration, this extract configuration must have the Draft status.

      If you want to use an Entity as input for Flow, please remember not to run the extract until you have defined the Flow. If you run the extract before the Flow is up and running, the data that would be exported to the Entity before the Flow is ready will not be processed.
      This is especially important if you want to use the scheduler feature. Remember to schedule the date for the first extract after you know the Flow will be ready.

    2. If you select the Frequency option:
      1. You need to define at least one configuration in the Primary frequency panel by selecting an option from the Repeat list and configuring its details. Click the Add button to add more settings. To learn more about time settings, refer to the Time Zone Support in the Scheduler section.
      2. If you need more than one frequency, click the Add additional frequency button and configure it in the same way as you did while defining the primary one. Note that each frequency setting must be unique within one frequency base, for example, you cannot add this setting Wednesdays at 11:00 AM more than once.

        If the same schedule time is introduced more than once within one extract configuration, then Fynapse schedules this extract configuration only once for this time.

  8. If you finished creating your extract configuration, you can now publish it by clicking the Submit extract button.

    Note that after submitting the extract configuration, you will only be able to edit some of its settings and other users will be able to see this configuration.

  9. Confirm your action.

    As mentioned earlier, do not run the extract configuration until you have defined the Flow. If you run the extract before the Flow is up and running, the data that would be exported to the Entity before the Flow is ready will not be processed.

  10. To start the extraction process on the basis of the newly created extract configuration, click the Run now button. The extraction process will start and you will see a proper extraction log in the Extraction Logs.

Balances Tutorials

  1. Go to Configuration > Extracts.
  2. Click the Add button.
  3. Provide basic information about your extract configuration:
    1. Type a name (we recommend keeping the names of extract configurations unique across the system) and optionally a description.

      While typing the name of an extract configuration, you can use upper-case and lower-case letters, digits, spaces, periods, exclamation marks, parentheses, hyphens, and underscore characters. We do not recommend using other special characters because it can cause problems while sending and downloading extract files.

    2. Configure the dates and time during which your extract configuration will be active by defining the Effective dates. You need to provide a start date and time. To configure an end date and time, click the Set End date and End time checkbox.
    3. Select a target name and a file type.
  4. Define data details:
    1. From the Namespace list, select fynapse.
    2. From the Data source list, select Balances.

      At this point, you can save your configuration as a draft by clicking the Save draft button. If you saved your work, then to continue configuring you need to click the Edit button.

  5. From the Saved criteria list select a saved query to determine which data will be extracted. Once you select the query it will be displayed below so that you can see its details.

    If the list is empty, then you need to go to Subledger > Balances to configure and save query criteria otherwise you will not be able to define the working extract configuration.

  6. Configure a scheduler to extract data at a defined time by selecting on which base it will be run:
    1. If you select the Specific dates option, then by clicking the Add button add as many dates as you need. The number of configured dates denotes how many times data will be extracted. Note that each specific date must be unique, for example, you cannot add this setting 25.07.2023 at 11:00 AM more than once. Additionally, defined dates must be included within the effective dates (defined in step 3b).

      If you do not want to use the scheduler and run the extract configuration manually, select the Disabled option. Keep in mind that to enable a previously disabled scheduler for a particular extract configuration, this extract configuration must have the Draft status.

    2. If you select the Frequency option:
      1. You need to define at least one configuration in the Primary frequency panel by selecting an option from the Repeat list and configuring its details. Click the Add button to add more settings. To learn more about time settings, refer to the Time Zone Support in the Scheduler section.
      2. If you need more than one frequency, click the Add additional frequency button and configure it in the same way as you did while defining the primary one. Note that each frequency setting must be unique within one frequency base, for example, you cannot add this setting Wednesdays at 11:00 AM more than once.

        If the same schedule time is introduced more than once within one extract configuration, then Fynapse schedules this extract configuration only once for this time.

  7. If you finished creating your extract configuration, you can now publish it by clicking the Submit extract button.

    Note that after submitting the extract configuration, you will only be able to edit some of its settings and other users will be able to see this configuration.

  8. Confirm your action.
  9. To start the extraction process on the basis of the newly created extract configuration, click the Run now button. The extraction process will start and you will see a proper extraction log in the Extraction Logs grid and the extract file will be placed on the defined cloud storage.
  1. Go to Configuration > Extracts.
  2. Click the Add button.
  3. Provide basic information about your extract configuration:
    1. Type a name (we recommend keeping the names of extract configurations unique across the system) and optionally a description.

      While typing the name of an extract configuration, you can use upper-case and lower-case letters, digits, spaces, periods, exclamation marks, parentheses, hyphens, and underscore characters. We do not recommend using other special characters because it can cause problems while sending and downloading extract files.

    2. Configure the dates and time during which your extract configuration will be active by defining the Effective dates. You need to provide a start date and time. To configure an end date and time, click the Set End date and End time checkbox.
    3. Select a target name and a file type.
  4. Define data details:
    1. From the Namespace list, select fynapse.
    2. From the Data source list, select Balances.

      At this point, you can save your configuration as a draft by clicking the Save draft button. If you saved your work, then to continue configuring you need to click the Edit button.

  5. From the Saved criteria list select a saved query to determine which data will be extracted. Once you select the query it will be displayed below so that you can see its details.

    If the list is empty, then you need to go to Subledger > Balances to configure and save query criteria otherwise you will not be able to define the working extract configuration.

  6. If you want to filter Balances using reference data, configure the following:
    1. Select the Dynamic filtering (attribute based) checkbox to enable the Criteria source reference Entity list.
    2. From the Criteria source reference Entity list, select the Entity which reference data you want to use for filtering.
    3. Match the reference attribute with the Balance attribute by selecting them from dedicated lists.

      To add more than one matching pair, click the Add button.

  7. To apply additional reference data filters, select the Set query attributes to extract only selected data checkbox.
    1. Click the Attributes field to see a list of reference Entity attributes. To select a particular attribute, click it.
    2. Define conditions and their values for previously selected attributes.

      To add more conditions to the selected attribute, click the Add button.

  8. Configure a scheduler to extract data at a defined time by selecting on which base it will be run:
    1. If you select the Specific dates option, then by clicking the Add button add as many dates as you need. The number of configured dates denotes how many times data will be extracted. Note that each specific date must be unique, for example, you cannot add this setting 25.07.2023 at 11:00 AM more than once. Additionally, defined dates must be included within the effective dates (defined in step 3b).

      If you do not want to use the scheduler and run the extract configuration manually, select the Disabled option. Keep in mind that to enable a previously disabled scheduler for a particular extract configuration, this extract configuration must have the Draft status.

    2. If you select the Frequency option:
      1. You need to define at least one configuration in the Primary frequency panel by selecting an option from the Repeat list and configuring its details. Click the Add button to add more settings. To learn more about time settings, refer to the Time Zone Support in the Scheduler section.
      2. If you need more than one frequency, click the Add additional frequency button and configure it in the same way as you did while defining the primary one. Note that each frequency setting must be unique within one frequency base, for example, you cannot add this setting Wednesdays at 11:00 AM more than once.

        If the same schedule time is introduced more than once within one extract configuration, then Fynapse schedules this extract configuration only once for this time.

  9. If you finished creating your extract configuration, you can now publish it by clicking the Submit extract button.

    Note that after submitting the extract configuration, you will only be able to edit some of its settings and other users will be able to see this configuration.

  10. Confirm your action.
  11. To start the extraction process on the basis of the newly created extract configuration, click the Run now button. The extraction process will start and you will see a proper extraction log in the Extraction Logs grid and the extract file will be placed on the defined cloud storage.
  1. Go to Configuration > Extracts.
  2. Click the Add button.
  3. Provide basic information about your extract configuration:
    1. Type a name (we recommend keeping the names of extract configurations unique across the system) and optionally a description.

      While typing the name of an extract configuration, you can use upper-case and lower-case letters, digits, spaces, periods, exclamation marks, parentheses, hyphens, and underscore characters. We do not recommend using other special characters because it can cause problems while sending and downloading extract files.

    2. Configure the dates and time during which your extract configuration will be active by defining the Effective dates. You need to provide a start date and time. To configure an end date and time, click the Set End date and End time checkbox.
    3. Select a target name and a file type.
  4. Define data details:
    1. From the Namespace list, select fynapse.
    2. From the Data source list, select Balances.

      At this point, you can save your configuration as a draft by clicking the Save draft button. If you saved your work, then to continue configuring you need to click the Edit button.

  5. From the Saved criteria list select a saved query to determine which data will be extracted. Once you select the query it will be displayed below so that you can see its details.

    If the list is empty, then you need to go to Subledger > Balances to configure and save query criteria otherwise you will not be able to define the working extract configuration.

  6. If you want to filter Balances using reference data, configure the following:
    1. Select the Dynamic filtering (attribute based) checkbox to enable the Criteria source reference Entity list.
    2. From the Criteria source reference Entity list, select the Entity which reference data you want to use for filtering.
    3. Match the reference attribute with the Balance attribute by selecting them from dedicated lists.

      To add more than one match, click the Add button.

  7. To extract only Balances for which reference data has changed since the previous extraction run, enable the Only extract Balances with changed reference data toggle switch.
  8. To apply additional reference data filters, select the Set query attributes to extract only selected data checkbox.
    1. Click the Attributes field to see a list of reference Entity attributes. To select a particular attribute, click it.
    2. Define conditions and their values for previously selected attributes.

      To add more conditions to the selected attribute, click the Add button.

  9. Configure a scheduler to extract data at a defined time by selecting on which base it will be run:
    1. If you select the Specific dates option, then by clicking the Add button add as many dates as you need. The number of configured dates denotes how many times data will be extracted. Note that each specific date must be unique, for example, you cannot add this setting 25.07.2023 at 11:00 AM more than once. Additionally, defined dates must be included within the effective dates (defined in step 3b).

      If you do not want to use the scheduler and run the extract configuration manually, select the Disabled option. Keep in mind that to enable a previously disabled scheduler for a particular extract configuration, this extract configuration must have the Draft status.

    2. If you select the Frequency option:
      1. You need to define at least one configuration in the Primary frequency panel by selecting an option from the Repeat list and configuring its details. Click the Add button to add more settings. To learn more about time settings, refer to the Time Zone Support in the Scheduler section.
      2. If you need more than one frequency, click the Add additional frequency button and configure it in the same way as you did while defining the primary one. Note that each frequency setting must be unique within one frequency base, for example, you cannot add this setting Wednesdays at 11:00 AM more than once.

        If the same schedule time is introduced more than once within one extract configuration, then Fynapse schedules this extract configuration only once for this time.

  10. If you finished creating your extract configuration, you can now publish it by clicking the Submit extract button.

    Note that after submitting the extract configuration, you will only be able to edit some of its settings and other users will be able to see this configuration.

  11. Confirm your action.
  12. To start the extraction process on the basis of the newly created extract configuration, click the Run now button. The extraction process will start and you will see a proper extraction log in the Extraction Logs grid and the extract file will be placed on the defined cloud storage.

REST API Tutorials

  1. Go to Configuration > Extracts.

  2. Click the Add button.

  3. Provide basic information about your extract configuration:

    1. Type a name (we recommend keeping the names of extract configurations unique across the system) and optionally a description.

      While typing the name of an extract configuration, you can use upper-case and lower-case letters, digits, spaces, periods, exclamation marks, parentheses, hyphens, and underscore characters. We do not recommend using other special characters because it can cause problems while sending and downloading extract files.

    2. Configure the dates and time during which your extract configuration will be active by defining the Effective dates. You need to provide a start date and time. To configure an end date and time, click the Set End date and End time checkbox.
    3. Select REST API as a target name.
  4. Define data details:

    1. From the Namespace list, select fynapse.
    2. From the Data source list, select the data source.
    3. If you selected FDS as the data source in the previous step, now from the Entity name list, select an Entity that you want to extract.

      At this point, you can save your configuration as a draft by clicking the Save draft button. If you saved your work, then to continue configuring, you need to click the Edit button.

    4. Select the Extract only incremental data checkbox if you want to extract data that was not extracted in the previous run of this extract configuration.
  5. Select the Set query attributes to extract only selected data checkbox to configure a query to determine which data will be extracted:

    1. To filter by certain attributes click the Attributes field to see a list of attributes. To select a particular attribute click it.

      If you do not select any criteria, then all data will be extracted.

    2. You must define filters for previously selected attributes by adding operators and configuring their values. To add another operator to the selected attribute, click the Add button.

    3. If you select a date attribute and set an operator to Dynamic, then you need to:

      1. From the list, select the period type, for example, Days.
      2. Define a number of days, months or years for which you want to extract data.
      3. From the Ending anchor list, select the point in time that sets the last day from which data will be extracted.
      4. If you select the Previous period end or Previous year end option from the Ending anchor list, then from the Fiscal calendar list, select the valid calendar.

      To ensure successful extraction, check whether the Fiscal Calendar you want to use has all periods defined and the calendar for a selected year exists in Fynapse. If the selected Fiscal Calendar does not have defined periods or the calendar for the selected year is not configured, then an error is thrown, and the extraction process fails. The error message is displayed in the Error message column on the Extraction Logs screen. Once you correct the calendar, the extraction process will be rerun automatically.

  6. Select the Aggregate Journal data checkbox to configure an aggregation for Journals and Unposted Journals. Set the aggregation:

    1. From the Dimension Set list, select a Dimension Set on which basis you want to aggregate data.

      If the list is empty, you will not be able to configure the aggregation. The Dimension Set must be configured first in Fynapse.

      Once you select the Dimension Set, its preview will be displayed in the Dimensions field, and the Measures field will display a list of fields (only amount field types) that will be summed to create the aggregation.

    2. From the Exclude dimensions from extract (optional) list, select Dimensions that you do not want to utilize for the aggregation. The list displays only user-defined Dimensions.

      If you want to create an advanced aggregation, refer to the Create Advanced Journal Aggregation description.

  7. You do not have to configure a scheduler since it will always be disabled for the REST API extract configurations.

  8. If you finished creating your extract configuration, you can now publish it by clicking the Submit extract button.

    Note that after submitting the extract configuration, you will only be able to edit some of its settings, and other users will be able to see this configuration.

  9. To run the extract, use the API tool. You will not be able to run it via Fynpase GUI. The extraction process will start and:

    1. You will see a proper extraction log in the Extraction Logs grid to confirm that the extraction was triggered.
    2. If the data source is Journal and you use the aggregation option, you will be able to see the Open journal link in the Journals column in the Extraction Logs grid. Once you click the link, you will be redirected to the Journals screen in Subledger to view all Journals that were included in the aggregation in the selected extract file.

You can convert an extract configuration to REST only if it does not have a defined scheduler.

  1. Go to Configuration > Extracts.

  2. In the grid, find and click an extract configuration that you want to convert to REST.

  3. Click the Convert to REST button.

    If you cannot see the Convert to REST button, this means that you selected the extract configuration that cannot be converted, for example, has a defined scheduler.

  4. Read the notification and confirm your action by clicking the Convert button.

    Conversion cannot be reverted.

    After conversion is completed, some changes will be visible on the Extraction Logs screen for all previous runs of the converted extract configuration. That is, the target space will be changed to REST API and some actions, such as reruning or downloading the extract file, will not be available.

Learn More