Marshal Archiver Admin - Administrating Scheduled Data Migration
Marshal Archiver is the backend Windows Service for running your information models. Marshal Archiver Admin is the windows application used to configure the Marshal Archiver jobs.
Image 1, Marshal Archiver Admin
The list view on left hand side of the window displays the jobs that you have added to Marshal Archiver, and if a job is selected, information about the job is displayed in the right hand side of the window. Each Job can contain any number of steps and each job can have any number of schedules.
Edit Job / Add New Job
To edit a job, double click on the job in the list view, or select the job in the list view and choose "Edit Job" in the File menu. To add a new job, select "New Job" in the File menu. The following window, image 2, will be displayed. The title of the window will depend on if you have chosen to add a new job or to edit an existing job.
Image 2, The general information page for a job
||Possible values are Full and ErrorsOnly. ErrorsOnly means that all errors, but nothing more is logged. When Full log level is used, information such as when a job is executed and finishes is also logged to the System Event Viewer.
|May execute on demand
||Check this box if you want to allow execution of the job via WCF.
||Only enabled jobs will be executed by the Marshal Archiver service.
||Give the job a name.
||If you wish, you can give the job a description.
The Steps page
Image 3, Configure the steps of your job
You can add any number of steps to a job, where each step can execute it's own Marshal model including pre and post processor. The steps are executed in the order they appear in the list. You can change the order of the steps by selecting one or more rows and move them with the up and down arrow buttons. The first step is executed when the job is executed, the second step is executed as soon as the first step is completed and so on.
- To add a new step, click on the New button.
- To delete a step, select the step and click on the Delete button.
- To edit a step, double click on the step.
Configuring a step
Image 4, Step configuration
||Start off by selecting a Marshal model. All Marshal models that are licensed for Marshal Archiver in your Marshal Repository are available in the drop down list. You can read more about the Marshal Repostory and how it is licensed in the article Marshal Repository.
|Execute import statements
||By checking this box, any import statements in the model will be executed after the export is completed, but before any post processor is executed.
|Export root directory
||You then select a directory where the exported data should be stored.
||If you wish, you can add a filter, that is passed to the root node harvester. The syntax of the filter depends on the harvester used. Please review the Harvester documentation for appropriate filter syntax. This way you can limit the exported data pretty much any way you like. You can read more about how to create Marshal models and how to use export filters in the Modeling articles. The export filter may be parametrized.
||You can optionally execute an application prior to the execution of the model. Any parameters passed to the job are passed to the pre processor, and the processor has the ability to add, edit and/or delete parameters. When the model executes, the parameters returned by the pre processor are used.
|Export custom headers
||Marshal allows you to add your own custom header elements to the export files. Custom headers can help users and applications to understand what the export contains and what the purpose of the export is. Typical export headers could describe which system has been exported and the puspose of the export. The values of the custom headers may be parametrized.
|Export folder naming
||Each export will be created in a new folder. Here you enter rules for how your export folders should be named. You can select from the variables JobDateTime, JobName, StepDateTime, StepName, Guid and None. You can edit the Format string any way you like. An example indicating how the export folder will be named is displayed.
|Post processor application
||Marshal Archiver can execute a post processor application when the execution of the Marshal model of the step is completed. The post processor will be executed with command line arguments making it easy for third party developers to develop post processors. The path to the export root file and export directory, the name of the job, the name of the Marshal model and the name of the step are always sent in the command line. Add the arguments you need for your post processor. The arguments may be parametrized. In this example, see image 4, the name of the artist being harvested is passed to the post processor.
Parameters may be used to alter the values of the export filter, custom headers and post processor arguments at runtime. The parameter syntax is param(any value), please see export filter and post processor argument of image 4. You can add any number of parameters to these fields.
If you add parameters, the parameters must be passed to the Job as execution time. The parameters may be passed from schedules, from the On Demand service or from a pre processor. In this example, the parameter artist is passed from the schedule, see image 6, and the value of the parameter, in this case x, is altered by the pre processor to the name of the artist to harvest information about.
The Schedules page
Image 5, Manage job schedules
Each job can have any number of schedules.
- To add a schedule, click on the New button.
- To edit a schedule, double click on the schedule.
- To Delete a schedule, select the schedule and click on the Delete button.
Configure a Schedule
Image 6, Schedule details
Start date is the first date and time the schedule will execute. You can also add a repeater. The schedule above will execute once every five minutes. If you only want to execute the job once, enter a start date but no repeater, i.e. set each value of the repeater to 0.
Schedules may pass parameters to the jobs, see Using parameters above. The parameters are used to manipulate certain information, such as export filter, at runtime.
Note. When you are have saved your new Marshal Archiver settings, you must restart the Marshal Archiver service for the changes to take effect!