https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260265#M29997 <P>I'm working with the Splunk Add-On Builder and am interested in learning more about some of the helper functions that are provided; namely, helper.save_check_point.</P> <P>This helper method is referred to in the "example data collection logic" code provided in the Add-On Builder wizard:</P> <H1>checkpoint related helper functions</H1> <H1>save checkpoint</H1> <H1>helper.save_check_point(key, state)</H1> <H1>delete checkpoint</H1> <H1>helper.delete_check_point(key)</H1> <H1>get checkpoint</H1> <H1>state = helper.get_check_point(key)</H1> <P>...but I can't find documentation anywhere about what these methods do, or what their inputs/outputs are. The <CODE>key</CODE> parameter in this example does not seem to be declared earlier in the example code, so I lack context to guess what this is doing.</P> <P>There are additional helper methods referred to in example code of which I'm additionally interested in learning usage details, like:<BR /> helper.set_log_level<BR /> helper.get_global_setting<BR /> helper.get_user_credential<BR /> and so on.</P> <P>I've tried searching through Splunk Docs, on google, etc. and find only the example code. Can someone point me in the direction of documentation/API reference for the Splunk Add-On Builder, specifically the helper module? Or can anyone provide some information about these helper functions?</P> <P>Many thanks in advance.</P> Tue, 29 Sep 2020 12:36:05 GMT ssanborn 2020-09-29T12:36:05Z https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260265#M29997 <P>I'm working with the Splunk Add-On Builder and am interested in learning more about some of the helper functions that are provided; namely, helper.save_check_point.</P> <P>This helper method is referred to in the "example data collection logic" code provided in the Add-On Builder wizard:</P> <H1>checkpoint related helper functions</H1> <H1>save checkpoint</H1> <H1>helper.save_check_point(key, state)</H1> <H1>delete checkpoint</H1> <H1>helper.delete_check_point(key)</H1> <H1>get checkpoint</H1> <H1>state = helper.get_check_point(key)</H1> <P>...but I can't find documentation anywhere about what these methods do, or what their inputs/outputs are. The <CODE>key</CODE> parameter in this example does not seem to be declared earlier in the example code, so I lack context to guess what this is doing.</P> <P>There are additional helper methods referred to in example code of which I'm additionally interested in learning usage details, like:<BR /> helper.set_log_level<BR /> helper.get_global_setting<BR /> helper.get_user_credential<BR /> and so on.</P> <P>I've tried searching through Splunk Docs, on google, etc. and find only the example code. Can someone point me in the direction of documentation/API reference for the Splunk Add-On Builder, specifically the helper module? Or can anyone provide some information about these helper functions?</P> <P>Many thanks in advance.</P> Tue, 29 Sep 2020 12:36:05 GMT https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260265#M29997 ssanborn 2020-09-29T12:36:05Z https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260266#M29998 <P>Currently, there is no doc about the helper function yet. But for the ckpt related functions.<BR /> the parameter key is a string which is the unique key for the state object. the state is a python dict which stores the states of your program.</P> <P>You can think the ckpt as a simple key-value store. the value is a python dict and the key is a string.</P> Mon, 06 Feb 2017 03:05:58 GMT https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260266#M29998 gwang_splunk 2017-02-06T03:05:58Z https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260267#M29999 <P>They have been released. Hope they help you as much as they have helped me <span class="lia-unicode-emoji" title=":winking_face:">😉</span><BR /> <A href="http://docs.splunk.com/Documentation/AddonBuilder/2.1.0/UserGuide/PythonHelperFunctions">http://docs.splunk.com/Documentation/AddonBuilder/2.1.0/UserGuide/PythonHelperFunctions</A></P> Fri, 10 Mar 2017 16:35:58 GMT https://community.splunk.com/t5/All-Apps-and-Add-ons/Splunk-Add-On-Builder-Is-there-any-documentation-or-information/m-p/260267#M29999 cmeerbeek 2017-03-10T16:35:58Z