Job schedules

The Job Schedules page allows you to access a comprehensive list of scheduled jobs and provides options to add or modify new jobs as needed.

To access the Job Schedules page, click Automation > Jobs > Schedules.

There are three steps to creating a job schedule on the three tabs on this page as follows:

 Note:  You can now run jobs that were defined in Data Integration in Financial Consolidation. See details.

Details Tab

The Details tab is the default view of the Job Schedules page.

 Note:  The layout of the Details tab depends on the type of Job selected.

Job types

The Job drop-down consist of a list of the job types that you can schedule. There are multiple Job types, including the following:

Backup job

This type of job allows you to make a backup of the selected consolidation periods at regular times. The Backup Job type contains the following parameters:

  • Code - unique code for the job.
  • Description - description of the purpose of the job.

  • Active - Selecting this option activates the job to run immediately upon clicking . To schedule the job instead, leave this option unselected.

  • Backup Type - the type of backup you want to schedule, e.g., for all periods, open periods, etc.

  • Choose periods from the Periods table.

    • To select all the periods, select this box: (on the table header, beside Code column).

  • Optionally, use the toggle click (the toggle switch) as follows:

    • Click once to display only the selected periods.

    • Click again to display only the unselected periods.

    • Click once more to display all the periods (both selected and unselected).

  • Password - to prevent users from restoring this backup at will, enter a password to secure the backup file.
  • Expiration Date - the last date by which the backup file can be restored.

  • Custom filename - a descriptive name for the backup file.

  • Periods - a list of consolidation periods, including their Code and Name, from which you can select to back up.

  • To allow other users to download this backup file, select the Available for download option.

After you have entered details for the type of job you selected, click and proceed to the Schedule tab to set up a schedule for the job.

Restore job

This job type allows selected consolidation periods to be restored at regular times. Backup files can be restored from a File or a URL.

Restore backup from a file

  1. In the Job Type drop-down, select Restore.

  2. Enter Code and Description for the job in their respective fields.

  3. Do one of the following: To run the job immediately, activate the job . To schedule the job, do not select the Active option.

  4. Set Restore Method to From File.

  5. In the File drop-down, select the backup file you want to restore. . The Name and Description of the backup file appear in their respective fields.

  6. Select the Periods you want to restore. The Periods table contains the Customer Name. In addition, it has an Overwrite column that allows you to select and overwrite the consolidation periods if they already exist.

    • To choose all the periods, select this box: (on the table header, beside Code column).

    • Optionally, use (the toggle switch) as follows:

      • Click once to display only the selected periods.

      • Click again to display only the unselected periods.

      • Click once more to display all the periods (both selected and unselected).

  7. Click .

Restore backup from a URL using an API Key

  1. In the Job Type drop-down, select Restore.

  2. Enter Code and Description for the job in their respective fields.

  3. Do one of the following: To run the job immediately, activate the job . To schedule the job, do not select the Active option.

  4. Set Restore Method to From URL.

  5. In the URL field, enter the URL from where the backup is to be restored.

  6. Leave the User field blank. Do not select this option.

  7. In The URL Password field, enter the API Key provided by the Administrator.

  8. Click .

  9. In the Password field, enter the password that was used to create the backup.

  10. Click . The Name and Description of the backup file appear in their respective fields.

  11. Select the Periods you want to restore.

    • To choose all the periods, select this box: (on the table header, beside Code column).

    • Optionally, use (the toggle switch) as follows:

      • Click once to display only the selected periods.

      • Click again to display only the unselected periods.

      • Click once more to display all the periods (both selected and unselected).

  12. Click .

Cleanup job

This type of job performs various cleanups in the system. It is good practice to have at least one instance running each day. The Cleanup Job type contains the following parameters:

  • Code - unique code for the job.
  • Description - purpose of the job.

  • Active - activates the job when selected an runs immediately upon clicking . The Cleanup job is enabled by default.

  • Delete imported data / Excel bundles older than - the Number of days the uploaded bundles files must be kept in the history before cleanup. If unsure, set to 31.

  • Delete files older than (in days) - number of days the period backups/ report batches/ other generated files must be kept in the period restore drop-down list before cleanup. If unsure, set to 365/30/30 respectively.

  • Delete temporary data sessions (in hours) - number of days all since temporary sessions were completed and(reports etc.) are kept available for download in the job overview. Number of hours the internal database sessions are kept. Those sessions are used to store temporary data for the application. If unsure, set unfinished sessions to 24 and completed sessions to 2.

  • Delete database entries generated since more than

    • Modification log- number of days the entries in the system logs are kept in the database. If unsure, set to 365.

    • Jobs - number of days the entries in the job overview page are kept in the database. If unsure, set to 365.

    • Concurrency detection - number of hours the database entries for multi-user concurrency detection are kept in the database. If unsure, set to 6.

  • Delete HUB entries generated since more than (in days) - number of days the database entries from HUB are kept in the database. If unsure, set to 31.

After you have entered details for the type of job you selected, click and proceed to the Schedule tab to set up a schedule for the job.

SysIndexRebuild and Index Rebuild jobs

These jobs help to resolve certain performance issues especially cases where data imports may stall. Each job helps to rebuild database indexes:

  • SysIndexRebuild, a System job, is enabled by default and scheduled to run weekly on Saturdays at 11:59 PM.

    • It automatically rebuilds database indexes to maintain system performance.

  • Index Rebuild is a user-initiated job

    • It allows index rebuilding to be run on-demand and can targeted to specific tables as needed.

Export cube job

This type of job allows you to synchronize the database with an OLAP cube. The Export cube Job type contains the following parameters:

  • Code - unique code for the job.
  • Description - purpose of the job.

  • Active - Selecting this option activates the job to run immediately upon clicking . To schedule the job instead, leave this option unselected.

  • Include Dimensions - job includes dimensions when selected.

  • Include Closed Periods job includes closed periods when selected.

  • Cube Definitions- Select one of the Cube Definitions, created under the Transfer menu

After you have entered details for the type of job you selected, click and proceed to the Schedule tab to set up a schedule for the job.

Data Integration job

This type of job allows you to run jobs that were defined in Data Integration.

The Data Integration job includes the following parameters:

  • Code - unique code identifying the job type code used for the export.
  • Description - lD of the user scheduling DI Studio job. This information is system-filled and cannot be modified.

  • Active - Selecting this option activates the job to run immediately upon clicking . To schedule the job instead, leave this option unselected.

  • Data Integration Jobs - the job (from the Data Integration ) that you want the process to run.

  • After you have entered details for the type of job you selected, click and proceed to the Schedule tab to set up a schedule for the job.

Validation report job

This job is used for scheduling all the validation reports for all companies to run simultaneously.

  1. Click .

  2. Select Validation report in the Job Type field.

  3. Enter a unique Code and Description for the job.

  4. Leave the Active option clear (unchecked)

  5. The Current and Ref. Periods are selected default, but you may click to select any other period to which you have access.

  6. The Company list displays the companies you are authorized to access in the period selected for the job.

  7. The Validation report list includes all the reports available in the selected period. From the list, select the validation report to generate.

  8. The Journal view field displays the available journal views, but by default, displays CONSO . You may click to select another option.

  9. Select the other parameters and click .

  10. To schedule the job, click on the Schedule tab.

Import adjustment data job

This job enables customers with Data Integration (DI) integration to load adjustments into the application with Data Integration.

See the Import adjustments table structure required in Prophix Staging.

  1. Click .

  2. Select Import Adjustment Data from the Job Type field.

  3. Enter a unique Code and Description for the job.

  4. You have these options:

    • To run the job immediately, job, select Active. The job will run immediately upon clicking .

    • To schedule the job instead, do not select the Active option

  5. In the Source field, select Prophix Staging.

  6. Select an Overwrite Option.

    • Overwrite Journals known in file - if selected, imported files overwrites only the adjustments that are available in the file.

    • Overwrite Journals of Period - if selected, imported file overwrites all existing journals.

    • Use journal entries from the import file - if selected, the journal entries from imported file will be used. No new ones will be generated.

  7. In the Available tables field, select a table.

  8. In the Package ID prefix field, enter a prefix (could be your initials, or any other group of letters approved by your team, etc.).

     Note:  The prefix you enter will be placed before the year and month for that package, helping you to quickly interact with the package upon import.

  9. Optionally, select Split by company to split the package into as many companies as there are in the data retrieved.

     Note:  Selecting Split by company adds the company code as a suffix to the Package ID for each company.

  10. Click . If you selected Active, the job runs immediately. To view the status of the job, go to the Jobs tab.

  11. To schedule the job, click on the Schedule tab. The job will run at the scheduled time and the data will be imported from Staging in the Consolidation HUB. The imported data packages will be in Transfers > HUB > Authorization. To accept or reject the package, proceed to Hub Authorization.

Import adjustments table structure required in Prophix Staging

The following is the required structure for the Import Adjustments (Prophix Staging) table in staging:

[ConsoCode] [nvarchar](12) NULL,

[CompanyCode] [nvarchar](20) NULL,

[JournalType] [char](1) NULL,

[JournalCategory] [nvarchar](3) NULL,

[JournalEntry] [bigint] NULL,

[JournalSequence] [int] NULL,

[Account] [nvarchar](20) NULL,

[PartnerCompanyCode] [nvarchar](20) NULL,

[Amount] [decimal](24, 6) NULL,

[Flow] [nvarchar](20) NULL,

[FlowTransRate] [decimal](28, 12) NULL,

[FlowTransactionAmount] [decimal](24, 6) NULL,

[TransRate] [decimal](28, 12) NULL,

[JournalDescription] [nvarchar](max) NULL,

[Behaviour] [tinyint] NULL,

[BeforeAfter] [bit] NULL,

[AdjCurrency] [char](1) NULL,

[AssociatedJournalType] [char](1) NULL,

[AssociatedJournalCategory] [nvarchar](3) NULL,

[CurrCode] [nvarchar](3) NULL,

[TransactionCurrCode] [nvarchar](3) NULL,

[TransactionAmount] [decimal](24, 6) NULL,

[DimensionGroup] [nvarchar](25) NULL,

[Dimension1Detail] [nvarchar](25) NULL,

[Dimension2Detail] [nvarchar](25) NULL,

[Dimension3Detail] [nvarchar](25) NULL

Export to reporting solutions job

Refer to Move consolidated data to reporting solutions for details.

Export for external applications job

Refer to Export data for external applications for details.

Schedule Tab

The Schedule tab display all the jobs that have been scheduled to run at specific times.

  1. Select the job you want to run from the left-side panel.

  2. Schedule the job to run as you desire. In this tab, you can schedule the jobs to run in different ways. There are four different options available:

    • Repeat - allows you to specify an interval (expressed in hours, minutes, and seconds) and to repeat the Job only on specific days, weeks of the month, or months of the year.
    • Interval - allows you to specify an interval (expressed in hours, minutes, and seconds) without any day, week, or month limitation.

    • Fixed - allows you to specify one specific date and time on which the Job will be run.

      If needed, you can also specify the Execution period — duration of the job schedule by entering the Period and To dates and times.

  3. After you have entered details for the type of job you selected, click .

  4. To view the status of the job, go to the Jobs tab or the Job Overview page.

Jobs Tab

The Jobs tab displays the status of a scheduled job. Select a job from the list on the left to display the status.

  • Status - result of the job run, either Done (successful) or Error. If there was an error executing the job, or a warning after the job is run, you can view the related message by clicking the icon at the end of the line for that job. You can filter the list by choosing a status from the Status drop-down list.
  • Action - shows whether the job has been run or pending.

    You can filter the list by choosing an action from the Action drop-down list.

  • Scheduled date - date and time of day when the job was scheduled to run.

    You can filter the list by choosing a range of dates from the Scheduled drop-down list.

  • Started date - date and time of day when the job was executed.

  • Ended date - date and time of day when the job was completed.

  • - indicates errors while running the job. Click on the icon to see the error details.
  • - indicates warnings on the job. Click on the icon to see the warning details.