Old link to JobFile Reference

[Mike4Online]

The home page of this GitHub project (i.e. the README) has a link to the JobFile Reference Guide. This link is for an old version (7.5 or 7.6). This link should be updated to point to the current JobFile Reference Guide, at the following URL:

https://download.nuix.com/system/files/Nuix%20Collector%20and%20ECC%20JobFile%20Reference%20Guide%20v8.6.pdf

• Michael Litwak (Nuix employee)

[JuicyDragon]

Updating now, thank you for reporting this and providing the updated link 😄

[Mike4Online]

Thanks for updating the link. I just realized that the JobFile Reference does not cover remediation-specific elements in the JobFile. These are intentionally left undocumented in the JobFile Reference, because remediation capabilities are intended to be driven by Workstation.

The Collections Team generates a RemeditionLib library, which allows Workstation to perform remediation. We have a customized version of the JobFile XML Schema to accompany RemediationLib. This schema includes a comprehensive set of documentation comments for all possible JobFile elements and attributes, including remediation-related items. Still, an XML Schema file is not the ideal way to deploy reference documentation.

I am considering writing a supplementary PDF document to cover remediation-related JobFile settings. I am not sure where I would publish this doc - perhaps having it here in this GitHub repository would be best. What do you think?

[JuicyDragon]

No problem on the link, was a real easy fix. Thanks for calling it out, I wouldn't have noticed it myself most likely. Yeah we could definitely include it in the repository. Seems like it would be an appropriate audience. Not sure how far reaching you think that would be, but if you feel this is just a supplement for this repo, could even write it up in markdown if you'd like. I have a little Ruby script that can save it out to rendered HTML with most of the GitHub stuff as you would see it on GitHub. Could easily turn that into a PDF then. Whatever format works for you works for me.

…

________________________________ From: Michael Litwak <notifications@github.com> Sent: Wednesday, June 17, 2020 11:47 AM To: Nuix/Nuix-Collector-Integration <Nuix-Collector-Integration@noreply.github.com> Cc: Jason Wells <jason.wells@nuix.com>; State change <state_change@noreply.github.com> Subject: Re: [Nuix/Nuix-Collector-Integration] Old link to JobFile Reference (#4) Thanks for updating the link. I just realized that the JobFile Reference does not cover remediation-specific elements in the JobFile. These are intentionally left undocumented in the JobFile Reference, because remediation capabilities are intended to be driven by Workstation. The Collections Team generates a RemeditionLib library, which allows Workstation to perform remediation. We have a customized version of the JobFile XML Schema to accompany RemediationLib. This schema includes a comprehensive set of documentation comments for all possible JobFile elements and attributes, including remediation-related items. Still, an XML Schema file is not the ideal way to deploy reference documentation. I am considering writing a supplementary PDF document to cover remediation-related JobFile settings. I am not sure where I would publish this doc - perhaps having it here in this GitHub repository would be best. What do you think? — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub<#4 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACZ256QBBJBRGMSP2XABQA3RXEFSRANCNFSM4OA2PQ7Q>.