Skip to Main Content
Feature Request FR-122
Product Area Application Builder
Status ROADMAP

64 Voters

Help API

fac586 Public · Jul 11 2012

Provide an API to maintain APEX page/item help entries.

Use cases: create programs for bulk upload of externally authored help text; create applications that allow users to maintain help text without access to the App Builder.

Whilst it's possible to create custom help solutions to do this, it would be preferable to have the ability to seamlessly use the built-in APEX help features whilst allowing maintainance of help text by both developers (through the App Builder) and non-developers (through custom applications).

This is currently on the roadmap for a future release of Oracle APEX.

Known Duplicates

Known duplicates

FR-2337
FR-2337 Function returning string for Help Text
FR-2945
FR-2945 Additional Sources for Page Item Help Text

Comments

Comments

  • morten.braten OP 13 years ago

    Excellent idea, this would be similar to the already existing APEX_UI_DEFAULT_UPDATE package.

  • scott.wesley OP 12.7 years ago

    I'm surprised this wasn't included in 3.x

  • jerome.erdmann OP 12.6 years ago

    Also,it would be great to have the possibility to choose the source of the help text.
    => Helptext based on SQL or PLSQL.

  • joep.hendrix1 OP 12.2 years ago

    It would be nice to have a help-application available based on all the help entered. This helpapp should have search and index capabilities just like the old MS .chm files have.

  • sorin.apalaghie OP 3.2 years ago

    This would be a good candidate for a Help feature which you could only enable (similar to the Feedback or Reporting features)

  • michael.weinberger 2 OP 3.2 years ago

    It would be great if some master-users are ablte to write the helptext for their colleagues.

  • morten OP 2.7 years ago

    Sooo… this simple idea was asked 10 years ago (!), and we still don’t have it…? :-(

  • sorin.apalaghie OP 2.7 years ago

    I think this should be a feature in itself, similar to the feedback feature. I always start of building any app by implementing a way for end-users to manage application level and page level help entries. This should be standard functionality.

  • jon dixon OP 2.7 years ago

    And Or provide bulk help text loader option in APEX builder.

  • gemma wood OP 2.7 years ago

    Well overdue.  Help text typically needs to be written/edited by business users not developers

  • joseph fuda OP 2.4 years ago

    See FR-2945 for a declarative approach to this problem that supports a broader range of help text requirements than the API for static text management proposed here in FR-122.

  • martin b. nielsen OP 2.4 years ago

    Perhaps it could be implemented by allowing a Help text “callback” function, much like the error handler we can set at app level. That would us developers to pick the help text from custom tables or any other source we have…

    Gets my vote (have build custom solutions for this too many times).

  • jon dixon OP 1.8 years ago

    I disagree that this is a duplicate of the “Known duplicates” FR-2337Function returning string for Help Text & FR-2945Additional Sources for Page Item Help Text

    FR-2945 and FR-2337 discuss providing a function to source help from wherever you want (local tables, REST APIs). This idea (FR-122) only talks about allowing you to update the help stored in APEX Builder via an API . Whilst also useful, these are two very different things. Allowing you to get help from wherever you want via a function call provides ultimate flexibility.