Product: Roster Server
Audience: ClassLink Administrator
Custom export configs allow you to export application data in your own format. This could be useful if a vendor wants data in a certain format that differs from OneRoster standards. You can create as many different configs for as many different apps as you would like.
Creating a Custom Export Config
1. To get started using custom exports, navigate to the new Custom Exports tab under the settings dropdown from the dashboard.
2. Click the blue Add Custom Export button to make a new config.
3. Choose whether you want a Pretransform Config or Create Your Own config. Give the config a name, fill out the other options if you wish, then click the green Create Config button to create the config. For Pretransforms, you must choose a Base Template, which will serve as the template you are preforming the Pretransforms on.
Create Your Own Setup
4. Click the blue Add File button to add the first file to your config.
5. Give your file a name and select the base file type. The base file type will determine what data you will have direct and indirect access to. In general, try to pick the file type that most closely resembles what you want your file to look like. For example, if you want one row in your file for every user, choose the users file type. If you want one row for every enrollment, choose the enrollments file type. When you've set the name and the type, click the blue Next button in the lower right corner.
6. For Selection Conditions, you can set as many (or as few) selection conditions as you want. These conditions filter your data down even more from your app's permissions. Only data that has permission to access to the app you're exporting and satisfies these selection conditions will be exported. When you're done, click Next.
7. This brings you to the Mappings tab where you decide what columns you want in your export. First, click the blue + icon to add a column.
8. Type in the column name you want and the value you want to populate this column with. The value can either be normal text, such as "student" or "34", or you can use any combination of fields and text. If you want to use a field, you can scroll through the list of available fields and use any of the data available.
9. Once you've added all the columns you want in this file, click Next.
10. This brings you to the Transforms tab which allows you to modify fields in your file based on other fields in the file. Click the blue + Add Transform button to add a transform.
11. Give the transform a name, then click Next to go to the Conditions tab.
12. Add as many conditions as you would like, then click Next to go to the Mappings tab. Only data that satisfies the conditions you set here will be transformed.
13. Click the blue + icon to add a transformation. Again, only data that meets the conditions you defined in Conditions will be transformed.
14. Once you've mapped all the fields you want, click anywhere to the left of the transform box to exit it. Create as many transforms as you would like, then click Finish to save everything in the file.
15. From here, you can add more files, edit or delete existing files, or save the whole config. Once you save it here, it's ready to go.
16. Give the config a name, fill out the other options and choose a Base Template from the dropdown list, then click the green Create Config button to create the config.
17. Here you can edit the config name and description. Click on the Edit Pretransform button.
On this page, you can see the relationship between each base collection and the export file.
18. Click on the base file you want to preform pretransforms on from the menu on the left side.
19. Click on the blue + icon to add a new pretransform.
20. Give the pretransform a name and click the blue Next button.
21. Add as many conditions as you would like, then click Next to go to the Mappings tab. Only data that satisfies the conditions you set here will be transformed.
22. Add the mappings you want here and click the green Finish button. Again, only data that meets the conditions you defined in Conditions will be transformed.
You can add as many pretransforms as you need for each file following the same steps.
23. Once done, click on the green Save Pretransforms button to save.
24. From here you can go back to edit the pretransforms, or click Save to save the Config.
Using Your Config
Once you've created your custom export config, using it in an export is quite easy.
1. Navigate to Applications from the dashboard, and click the Other Actions menu (three dots) to the right of the application you want to apply the config to, then select Export Settings.
2. Fill in the appropriate fields if you haven't already. Then, under File Details, select your custom config from the drop-down menu.
3. After choosing a custom config, you will see a warning letting you know to enable Filter Fields. This warning will only show if the config you have selected is using metadata fields.
4. Fill out any other options you would like, then click Save. This app's export data will now be in the format specified by your custom export config.
Updated: Nov 2020