This task allows users to modify the output of current
roster exports. When installing or upgrading to application v7.1.8,
or v7.2.1 a new template folder will appear, the templates folder
is used to drop modified roster exports to be picked up by the new
Roster Export task. Roster Export FTL template files, such as ROS02,
ROS05… are available in the sample folder located in the integration folder
also available upon installation or upgrade to v7.1.8+, or v7.2.1+
- Application Version 7.1.8+, or 7.2.1+
- Locate the sample roster export templates, for example ROS05,
ROS04, ROS08. The default location is C:\Program Files<\Application
Name>\integration\samples
- Locate the template folder. The default location is C:\Program
Files\<Application Name>\template
- Best Practice: Create a backup folder, copy the unmodified
templates and place them in the backup folder to store unmodified
copies of the templates.
IMPORTANT: The Roster Export task is available
as of application version 7.1.8+, and 7.2.1+. The Roster Export
task type can be used with any of the roster export FTL file templates
available in the integration samples folder. The roster templates
can be modified, and any roster export fields can be included or
excluded to produce the desired output. Only FreeMarker (FTL) files
are supported. To create and run a modified roster export:
- Locate the sample roster export templates, for
example ROS05, ROS04, ROS08. The default location is C:\Program
Files\<Application Name>\integration\samples
- Choose the roster export template, and modify the tags
using your preferred editing tool. Choose Save, or Save as. The
extension must be *.ftl
- Copy the modified *.ftl file into the templates folder.
The default location is C:\Program Files\<Application
Name>\template
- Go to Setup > System > Task Manager to create
a new task.
- Click Add.
- In General > Name, provide a meaningful name for this
job.
- In Task > enter a name for this task. Generally, the
same name provided on the General tab is used.
- In Task Type, select Roster 08 Export.
- Set From and Through.
- Configure the remaining fields as desired. No selections
means all items selected and returned when applicable and dependent
on other settings, such as Send Changes Only in which case only changes
are sent. Optional step for this task example.
- In Transform File Using Template (.ftl) type the
name of the file exactly as it appears in the template folder
in step 3. Case sensitive, and must have extension *.ftl
- Clear the check box: Generate according to change
settings (unchecked sends entire Roster). See Task Properties
Fields Descriptions topic for field definitions if needed.
- Click Save.
- Run the task, and go to your integration / exports folder
and locate your file. The default location is: C:\Program
Files\<Application Name>\integration\samples