Macros

The Macros tab allows you to automate your REST API use by using a macro instruction file (seeMacros Tab). This tab is useful if you want to build or run a list of commands in a specific order, or multiple times as a test. You can also use Macros to ensure that a long list of commands is executed without manual input errors, saving time.

Figure 1: Macros Tab

1.Load specifies the path to your pre-existing macro file.

2.The commands specified in your macro file appear in the Macro Info box.

3.To create a new macro file, click REC to record your actions with the REST API. You can keep track of what you have done in the Macro Info box. Click STOP REC when finished.

4.This box allows you to name your newly-created macro file or rename a pre-existing file you loaded and may have edited.

5.To save a new or edited macro file, click Save. Specify your save path.

6.To execute the commands specified in your macro file, click PLAY.

7.Use Default HSM/PARTITION plays your macro file instructions on the default HSM or partition. Deselect it to play your macro file on a different HSM.

Example

To create a new macro file:

1.Click REC to begin recording your actions.

2.Click on a command button in any tab to initiate its corresponding resource. Continue inputting commands until you are satisfied with your output.

3.Go to the Macros tab. Click STOP REC.

4.You can view your input history in the Macro Info box to ensure you have the order of commands you want. You can also PLAY your newly-created file to check that it works properly.

5.Name your macro file in the box at the top.

6.Click Save to specify a path to where you want to save your macro file.

If you are successful, the Raw IO tab at the bottom will turn green and show you a record of your request and its response. If you are using the Formatted IO tab to track your outputs, you only see the response values.

If you are unsuccessful, the Raw IO tab will turn red and return an error. The Formatted IO tab will fail to populate with defined values, returning an error.