{"id":1144,"date":"2008-02-29T03:45:33","date_gmt":"2008-02-29T09:45:33","guid":{"rendered":"http:\/\/www.mrc-productivity.com\/docs\/?page_id=1144"},"modified":"2023-04-13T13:59:04","modified_gmt":"2023-04-13T18:59:04","slug":"changing-maintenance-modes-via-url-parameters","status":"publish","type":"ht_kb","link":"https:\/\/www.mrc-productivity.com\/docs\/knowledge-base\/changing-maintenance-modes-via-url-parameters","title":{"rendered":"Setting Maintainer Action Mode via URL Parameter"},"content":{"rendered":"\n

Overview<\/h2>\n\n\n\n

When you run a Single Row Maintainer the default action mode is set to Add. However, what if you want your maintainer to add or update, based on which link a user clicks? Rather than making three separate applications, you can control the action of the maintenance application based on aURL parameter.<\/p>\n\n\n\n

Action Modes<\/h2>\n\n\n\n

Use the URL parameter “action_mode” and values: ‘add’, ‘update’, ‘delete’, ‘copy’, and ‘view’ to control the action mode like so:<\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=add<\/code><\/p>\n\n\n\n

If using any action mode other than ‘Add’ you are required to also pass the dimension key field(s) as parameters to know which record to pull back. <\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=update&CNUM=100001<\/code><\/p>\n\n\n\n

Fields may be pre-populated in the form by passing the field name and the desired value through the URL, like so:<\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=update&CNUM=100001&CSTATE=CO<\/code><\/p>\n\n\n\n

Parameter names are governed by HTML laws, which require case sensitivity — “CNUM” is different than “cnum”.<\/p>\n\n\n\n

Add Mode<\/h3>\n\n\n\n

By default, Single Row Maintainers are set to Add mode. However, you may still use the action_mode parameter. <\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=add<\/code><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

Because the maintainer is in add mode, the form has blank inputs (aside from the Customer # dimension key which is set to auto-sequence<\/a><\/strong>) ready for data entry.<\/p>\n\n\n\n

Again, input fields can be pre-populated in the form by passing the field name and value as a parameter:<\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=add&CSTATE=CO<\/code><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

Update Mode<\/h3>\n\n\n\n

DICTIONARY.M00010s?action_mode=update&CNUM=100001<\/code><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

Notice that this link automatically ran the application, pulled back the record where the key field (CNUM) is equal to “100001” and now allows the user to update any field other than the key field. In update mode, the dimension key(s) will always be read-only.<\/p>\n\n\n\n

If using the action_mode=update parameter, the dimension key parameter is also required<\/strong> to know which record to update.<\/p>\n\n\n\n

Delete Mode<\/h3>\n\n\n\n

DICTIONARY.M00010s?action_mode=delete&CNUM=100001<\/code><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

This link also runs the application and automatically pulls back the record based on the key parameter. In delete mode, all fields are set to read-only and the user is prompted to confirm deletion of the record.<\/p>\n\n\n\n

If using the action_mode=delete parameter, the dimension key parameter is also required<\/strong> to know which record to delete.<\/p>\n\n\n\n

Copy Mode<\/h3>\n\n\n\n

DICTIONARY.M00010s?action_mode=copy&CNUM=100001<\/code><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

In copy mode, the specified record’s data is pulled to the form, allowing the user to change all fields including the dimension key and will add the record upon submission.<\/p>\n\n\n\n

If using the action_mode=copy parameter, the dimension key parameter is also required<\/strong> to know which record to copy.<\/p>\n\n\n\n

View Mode<\/h3>\n\n\n\n

DICTIONARY.M00010s?action_mode=view&CNUM=100001<\/code><\/p>\n\n\n\n

\"\"\/<\/figure>\n\n\n\n

While in view mode, all fields are read-only and the “Accept” (submit) button is hidden. <\/p>\n\n\n\n

If using the action_mode=view parameter, the dimension key parameter is also required<\/strong> to know which record to view.<\/p>\n\n\n\n

One Step Mode<\/h2>\n\n\n\n

All of the above scenarios have dealt with how to call a maintainer and then allow the user to work with the record in question. However, you may have a need to call the maintainer “in the background” without displaying the on-screen form to the user. You may even pass the new field values to the maintainer in order to add, update or copy the record.<\/p>\n\n\n\n

The URL to update a record might look like this:<\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=update&CNUM=12345&CSTATE=NE<\/code><\/p>\n\n\n\n

To make it automatically carry out the update, include the following parameter to the end of the URL string:<\/p>\n\n\n\n

&one_step=1<\/code><\/p>\n\n\n\n

The whole string now looks like this:<\/p>\n\n\n\n

DICTIONARY.M00010s?action_mode=update&CNUM=12345&CSTATE=NE&one_step=1<\/code><\/p>\n\n\n\n

This instructs the maintainer to execute the update in one single step, without showing the user any screens.<\/p>\n\n\n\n

On Screen Redirect <\/h3>\n\n\n\n

By default, the maintainer will redirect back to itself in add mode after submission regardless of the action mode used. To change this, you can specify a redirect via the Workflow Designer<\/strong><\/a>. <\/p>\n","protected":false},"excerpt":{"rendered":"

Overview When you run a Single Row Maintainer the default action mode is set to Add. However, what if you want your maintainer to add or update, based on which link a user clicks? Rather than making three separate applications, you can control the action of the maintenance application based…<\/p>\n","protected":false},"author":1,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[252],"ht-kb-tag":[],"class_list":["post-1144","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-maintainer"],"_links":{"self":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/1144","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/comments?post=1144"}],"version-history":[{"count":12,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/1144\/revisions"}],"predecessor-version":[{"id":12544,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/1144\/revisions\/12544"}],"wp:attachment":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/media?parent=1144"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-category?post=1144"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-tag?post=1144"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}