State of "Plugins" within Arches ecosystem

[Adam Cox]

Hello all,

I'd like to ask an open-ended question about plugins. I've heard them talked about in the past as something that will allow Arches developers to make discreet contributions to the Arches platform to introduce custom functionalities in an optional manner.

I'm wondering what the status of this architecture is. Are there portions of the app currently that are fully architected as a "plugin" which could be looked at as an example of how to make a new one? I know there are lots of different facets of Arches that seem like they could be plugins, for example the Arches Collector Manager, but I'm wondering if anything is actually implemented through the "plugin framework" that I have heard about in the past.

Thanks,

Adam

[Cyrus Hiatt]

Hi Adam - 

The plugin architecture is completed in arches master (although we still need to get this process fully documented), so you can start working on plugins for your project. They are implemented with the same pattern used for other components such as cards and widgets. We have developed a few plugins in the consultations project. The simplest of these is probably the 'init-workflow' plugin which basically provides a menu of workflows that a user might want to start. 

component: https://github.com/archesproject/consultations-prj/blob/master/consultations_prj/media/js/views/components/plugins/init-workflow.js

template: https://github.com/archesproject/consultations-prj/blob/master/consultations_prj/templates/views/components/plugins/init-workflow.htm

config: https://github.com/archesproject/consultations-prj/blob/master/consultations_prj/plugins/init-workflow.json

Note that the config has a property 'show' which is set to 'false'. This determines whether the plugin shows up in the arches main navbar. For most plugins, this will probably be set to 'true'. 

Hope that helps,

Cyrus

--
You received this message because you are subscribed to the Google Groups "Arches Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to arches-dev+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/arches-dev/4a69092c-1e8f-4fb9-a6e6-0d1ebbe35696%40googlegroups.com.

--

Cyrus Hiatt
Geospatial Web Developer
Farallon Geographics
601 Montgomery St, Suite 1095
San Francisco, CA 94111
Office: 415.227.1140
Cell: 831.295.2439

[Adam Cox]

Hi Cyrus! Thanks for the quick and detailed response. If this is in master, is it not in stable/4.4.x? I'm thinking that the next release made from master will be 5.0.0, in early 2020, correct?

You're right, this should make it into the docs, so I just made a ticket for it here: https://github.com/archesproject/arches-docs/issues/129

Adam

On Wednesday, September 25, 2019 at 9:17:23 AM UTC-5, Cyrus Hiatt wrote:

Hi Adam - 

The plugin architecture is completed in arches master (although we still need to get this process fully documented), so you can start working on plugins for your project. They are implemented with the same pattern used for other components such as cards and widgets. We have developed a few plugins in the consultations project. The simplest of these is probably the 'init-workflow' plugin which basically provides a menu of workflows that a user might want to start. 

component: https://github.com/archesproject/consultations-prj/blob/master/consultations_prj/media/js/views/components/plugins/init-workflow.js

template: https://github.com/archesproject/consultations-prj/blob/master/consultations_prj/templates/views/components/plugins/init-workflow.htm

config: https://github.com/archesproject/consultations-prj/blob/master/consultations_prj/plugins/init-workflow.json

Note that the config has a property 'show' which is set to 'false'. This determines whether the plugin shows up in the arches main navbar. For most plugins, this will probably be set to 'true'. 

Hope that helps,

Cyrus

On Tue, Sep 24, 2019 at 5:39 PM Adam Cox <mr.a...@gmail.com> wrote:

Hello all,

I'd like to ask an open-ended question about plugins. I've heard them talked about in the past as something that will allow Arches developers to make discreet contributions to the Arches platform to introduce custom functionalities in an optional manner.

I'm wondering what the status of this architecture is. Are there portions of the app currently that are fully architected as a "plugin" which could be looked at as an example of how to make a new one? I know there are lots of different facets of Arches that seem like they could be plugins, for example the Arches Collector Manager, but I'm wondering if anything is actually implemented through the "plugin framework" that I have heard about in the past.

Thanks,

Adam

--
You received this message because you are subscribed to the Google Groups "Arches Development" group.

To unsubscribe from this group and stop receiving emails from it, send an email to arche...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/arches-dev/4a69092c-1e8f-4fb9-a6e6-0d1ebbe35696%40googlegroups.com.