Changes since Execute 21.1.321

To create, edit, or remove Global Templates, you must have the Manage Global Templates privilege. Users with this privilege will see an “All Global Templates” report in the report list on the browse page of eligible documents.

To mark a document as a Global Template, view the document and select “More > Mark as Global Template”. A Global Template Description is required and can guide creators as to the information within that template. Documents that are marked as a Global Template can only be edited by users with the Manage Global Templates privilege. Once a document is marked as a Global Template, creators will see a list of the templates under the “Create New” button.

If a creator has used the template button on an AFE or a Job to create their own templates, these user templates will also be listed under the “Create New” button, along with any Global Templates.

There are two columns that can been added to a browse report in order to find documents that have been marked as a Global Template:

• Is Global Template
• Global Template Description

A creator will only see Global Templates listed that they have permissions to see, according to their view rights.

Note: If your organization uses advanced workflows and plans to use the Global Templates feature, you may want to adjust the workflow activation rules to exclude documents marked as a Global Template.

Bulk Sync API

A new API (POST to /api/bulk/sync) allows bulk creation, updating, and inactivation of documents using CSV data.

This can be used to keep a list of data in Execute synchronized with an external system. Any tool that can extract data as a CSV file and perform an HTTP POST will now be able to update Execute data.

Example Usage

The API is reached at https://YOUR_SERVER/api/bulk/sync?type=PARTNER&dryrun=true.

Authentication uses Execute API Keys via HTTP Basic Auth.

The type= query parameter is required and indicates which Execute document type will be updated.

Other parameters are available to control the sync behaviour, see the documentation.

The dryrun=true parameter is useful for testing — it runs the full sync and returns a report of what would happen without making any changes to the data. Remove it (or set it to false) when ready to commit.

Each row in the CSV identifies one or more documents and provides value columns to update the data on the matched document(s).

The CSV header row contains the field path for each column. Columns prefixed with $ are key columns used to find matching documents; the remaining columns are the values to update.

Here is a CSV for Execute PARTNER data which will match on the partner code to update the name and address.

COMNAME,$CODE,STRADDRESS
Sesame Exploration,39,123 Sesame Street
Micro Eggbert Oil,12,"1111, 111 - 1st Avenue S.W."
Example Ltd.,10,"3300, 333.3 - 3rd Avenue S.W."

It could be sent to the Execute API with curl like so:

curl -u "$APIKEY_ID:$APIKEY_KEY" \
  -X POST "https://YOUR_SERVER/api/bulk/sync?type=PARTNER&dryrun=true" \
  -H "Content-Type: text/csv" \
  --data-binary @sample.csv

With dryrun=true, the response shows what would happen without making any changes:

Record,Level,Message
1,Info,DRY RUN: Would update document a1b2c3d4-...
2,Info,DRY RUN: Would update document b2c3d4e5-...
3,Info,DRY RUN: Would update document c3d4e5f6-...
Summary,Info,"Summary: 0 created, 3 updated, 0 unchanged, 0 inactivated, 0 errors, 0 warnings"

Once the results look correct, remove dryrun=true to commit the changes. The response will then confirm what was actually updated:

Record,Level,Message
1,Info,Updated document a1b2c3d4-...
2,Info,Updated document b2c3d4e5-...
3,Info,Updated document c3d4e5f6-...
Summary,Info,"Summary: 0 created, 3 updated, 0 unchanged, 0 inactivated, 0 errors, 0 warnings"

The Team and Approvals tabs can be turned off by adding the following to the <castle> container in user.config.

To turn off the Teams tab:

<?define SUPPRESS_RTX_TEAM_TAB ?>

To turn off the Approvals tab:

<?define SUPPRESS_RTX_APPROVALS_TAB ?>